Read More
Read More
Menu Close

    Product API: Multi-Vendor Marketplace for Shopify

    Product API

    Multivendor Product API: Product API is the resource that lets you update and create products in a merchant’s store.

    Base URL: https://mvmapi.webkul.com

    update
    product-api4-

    What you can do with Multivendor Product API

    GET /api/v2/products.jsonGet all products of a store
    POST /api/v2/products.jsonCreate/Add a new product to the store
    GET /api/v2/public/products/count.jsonGet count of all products
    PUT /api/v2/products/{productId}/variants/{variantId}.jsonUpdate variant by product id & variant id
    GET /api/v2/public/products.json Get all products
    PUT /api/v2/products/{productId}.jsonUpdate product by product id
    GET /api/v2/public/hyperlocal/products.jsonGet all hyperlocal product
    PUT /api/v2/products/{productId}.jsonUpdate product by product id
    GET /api/v2/public/hyperlocal/products/count.jsonGet count of all hyperlocal products
    DELETE /api/v2/products/{productId}.jsonDelete product by product id
    GET /api/v2/products/{productId}.jsonGet product by product id
    PUT /api/v2/products/{productId}/collections.jsonUpdate product collections by product id
    GET /api/v2/products/count.jsonGet count of all products
    DELETE /api/v2/products/{productId}/images.jsonDelete product image by product id
    GET /api/v2/products/{productId}/collections.jsonGet all collections by product id
    POST /api/v2/products/{productId}/variants.jsonCreate/Add a new variant for a product
    GET /api/v2/products/{productId}/images.jsonGet all images by product id
    DELETE /api/v2/products/{productId}/variants/{variantId}.jsonDelete product variant by product id & variant id
    GET /api/v2/products/{productId}/variants.jsonGet all variants by product id
    PUT /api/v2/products/{productId}/custom-fields.jsonUpdate/Add custom fields for product
    GET /api/v2/products/{productId}/variants/{variantId}.jsonGet variant by product id & variant id
    DELETE /api/v2/products/{productId}/variants/{variantId}/images/{imageId}.jsonDelete images of variant by image id
    GET /api/v2/products/{productId}/custom-fields.jsonGet product custom fields by product id
    PUT /api/v2/products/{productId}/commission.jsonUpdate product commission by product id
    GET /api/v2/products/tags.jsonGet product tags
    PUT /api/v2/products/{productId}/variants/{variantId}/commission.jsonUpdate variant commission by variant id
    GET /api/v2/products/collections.jsonGet product collection
    GET /api/v2/products/{productId}/variants/{variantId}/commission.jsonGet variant commission by variant id
    GET /api/v2/products/types.jsonGet product type
    GET /api/v2/products/{productId}/commission.jsonGet product commission by product id
    GET /api/v2/products/{productId}/global_products.json
    Get all seller’s global products by id
    GET /api/v2/products/moq/{shopifyProductId}.jsonGet minimum order quantity of product variants
    DELETE /api/v2/products/{productId}/images/{imageId}.jsonDelete image of product by image id
    GET /api/v2/products/features-type.jsonGet product features type
    GET/api/v2/filter-products-by-tags.jsonGet products by tags and vendor
    GET/api/v2/count-products-by-tags.jsonCount products by tags and vendor

    Product Properties

    idThis is the product ID which is a unique human-friendly string for the product.
    main_id_shopThis is the admin store’s unique ID.
    seller_idVendor ID
    product_nameThis returns the name of the product.
    product_typeA categorization for the product used for filtering and searching products.
    product_descriptionReturns the description of the product.
    product_tagA string of comma-separated tags that are used for filtering and search. A product can have up to 250 tags. Each tag can have up to 255 characters.
    handleA unique human-friendly string for the product. Automatically generated from the product’s title.
    product_meta_infoMetafields are extra pieces of data that apps can attach to products.
    priceThe price of the product.
    compare_at_priceThe original price of the item before an adjustment or a sale.
    sales_priceThis returns the sales price. If off the value will be -1.
    handling_chargesThis returns the handling charges of the product.
    transaction_chargesThis returns the transaction charges of the product.
    track_inventoryReturns if the fulfillment service tracks the number of items in stock for the product variant or not.
    Valid values:
    0: Doesn’t Track
    1: Track
    quantityThis returns the product quantity.
    inventory_policyWhether customers are allowed to place an order for the product variant when it’s out of stock.
    Valid values:
    0: Customers are not allowed to place orders for the product variant if it’s out of stock.
    1: Customers are allowed to place orders for the product variant if it’s out of stock.
    Default value: 0.
    activeValue- 0/1. Returns the product status as live or not.
    skuA unique identifier for the product variant in the shop. Required in order to connect to a Fulfillment Service.
    barcodeThe barcode, UPC, or ISBN number for the product.
    has_default_shippingThis returns 0/1, i.e., if product has shipping (1) or not (0).
    has_multiple_optionsReturns 1 if the product has variants. (In case of digital product returns 0)
    charge_taxesWhether a tax is charged when the product is sold. Valid values are 0 & 1.
    tax_typeReturns the tax type.
    hsnReturn the product HSN value. (Only for GST Feature App)
    cgstReturn the product CGST value. (Only for GST Feature App)
    sgstReturn the product SGST value. (Only for GST Feature App)
    gstReturn the product GST value. (Only for GST Feature App)
    product_policyReturns if the product includes policy or not.
    id_parentReturns global product ID.
    product_urlThis is for Directory Listing feature of the app.
    expiry_dateThis is for the product expiry feature.
    design_idThis is for the Artist Product Design feature.
    date_addThe date and time when the product was created.
    typeThis returns the product type as Normal or Digital.
    “type”: {
                    “id”: 1,
                    “type_name”: “normal”
                },

    Variant Properties

    idAn unsigned 64-bit integer that’s used as a unique identifier for the variant.
    product_idThis is a unique product ID.
    shopify_product_idThis is a unique Shopify product ID.
    shopify_variant_idThis is a unique Shopify variant ID.
    image_idThis is a unique image ID of the variant’s image.
    weightThe weight of the product variant in the unit system.
    track_inventoryReturns if the fulfillment service tracks the number of items in stock for the product variant or not.
    Valid values:
    0: Doesn’t Track
    1: Track
    quantityThis returns the variant quantity.
    date_addThe date and time when the product was created.
    dimensionThis returns the dimensions of the variants added in the store. (json format)
    inventory_policyWhether customers are allowed to place an order for the product variant when it’s out of stock.
    Valid values:
    0: Customers are not allowed to place orders for the product variant if it’s out of stock.
    1: Customers are allowed to place orders for the product variant if it’s out of stock.
    Default value: 0.
    id_parentReturns global product ID.
    combinationsReturns store attributes.
    “combinations”: [
    {
    “id”: 1000001,
    “variant_id”: 10001,
    “option_value”: “Default Title”
    }
    inventory_locationsReturns the location of variant’s inventory, i.e., location, location ID & quantity.
    “inventory_locations”: [
    {
    “id”: 1001,
    “product_id”: 10001,
    “variant_id”: 100001,
    “variant_quantity”: 10,
    “location_id”: 11,
    “location_name”: “India”,
    “shopify_location_id”: 100000000001
    }
    ]

    Options Properties

    idAn unsigned 64-bit integer that’s used as a unique identifier for the option.
    nameThe custom properties that a shop owner uses to define product variants. You can define three options for a product: option1option2option3.
    product_idThis is a unique product ID.
    valuesReturns the values like id, option id & value of the option.
    “values”: [
    {
    “id”: 10001,
    “option_id”: 100001,
    “value”: “Default Title”
    }
    ]

    Image Properties

    idThe unique numeric identifier for a product’s image. The image must be associated to the same product as the variant.
    product_idThis is a unique product ID.
    activeStatus of the image that whether it is live or not.
    positionReturns the position of the image.
    img_urlReturns the image URL.
    img_smReturns the image URL.
    img_mdReturns the image URL.
    img_lgReturns the image URL.
    img_altReturns the image alt text.
    process_statusIf the image is updated on our S3, it will return processed otherwise in-process.

    Collection Properties

    idAn unsigned 64-bit integer that’s used as a unique identifier for the collection.
    product_idThis is a unique product ID.
    shopify_category_idThis is the Shopify’s unique ID for collection.
    category_nameThis returns the name of the collection.
    handleA unique human-friendly string for the product. Automatically generated from the collection’s title.
    levelReturns 1 if the collection has subcategories. Else, returns o.
    id_parentIf level=1, it returns the ID of the parent category.
    activereturns the status of the category. 0 for active, 1 for not active.

    End Points

    GET /api/v2/products.json

    Get all the products of a store

    Parameters

    Searching for a Shopify Searching for a Shopify Headless solution ? Read More

    Name

    page
    integer
    (query)

    limit
    integer
    (query)

    sort_by
    string
    (query)

    sort_order
    string
    (query)

    filter
    string
    (query)

    Description

    Return a specific page of results.
    Default value: 1

    ⠀⠀⠀

    Return up to this many results per page. (maximum: 250)
    Default value: 50

    Determines the parameter by which the products are sorted in the response. Available parameters are id, product_name, id_shop, price, quantity, date_add.
    Default value: date_add

    Determines the sorting order. 1).asc-> ascending 2).desc-> descending
    Default value: desc

    Searches only for the products with the specified ‘id’, ‘product_name’, ‘id_shop’, ‘price’, ‘type’, ‘handle’, ‘product_type’, ‘platform’, ‘active’.
    Example:

    {"id":"10001", "product_name":"White Shirt", "id_shop":"10001", "type":"1" , "active":"1"}

    RESPONSE

    {
        "products": [
            {
                "id": 10001,
                "main_id_shop": 101,
                "seller_id": 1001,
                "product_name": "Test Product",
                "product_type": "test",
                "product_description": "<p>product description</p>",
                "product_tag": "[\"test_tag\"]",
                "handle": "test-product",
                "product_meta_info": null,
                "price": "100.00",
                "compare_at_price": "0.00",
                "sales_price": "132.00",
                "handling_charges": "10.00",
                "transaction_charges": "12.00",
                "track_inventory": 1,
                "quantity": 20,
                "inventory_policy": 1,
                "active": 1,
                "has_default_shipping": 1,
                "has_multiple_options": 1,
                "charge_taxes": 1,
                "tax_type": null,
                "hsn": null,
                "cgst": "0.00",
                "sgst": "0.00",
                "gst": "0.00",
                "product_policy": "product_policy",
                "id_parent": 0,
                "product_url": "",
                "expiry_date": null,
                "platform": 0,
                "design_id": 0,
                "date_add": "2019-11-20T07:13:24+00:00",
                "date_upd": "2019-11-20T08:24:51+00:00",
                "type": {
                    "id": 1,
                    "type_name": "normal"
                },
                "variants": [
                    {
                        "id": 100001,
                        "product_id": 10001,
                        "shopify_product_id": 1000000001,
                        "shopify_variant_id": 10000000001,
                        "image_id": 1000001,
                        "sku": "H101",
                        "price": "100.00",
                        "sales_price": "132.00",
                        "handling_charges": "10.00",
                        "transaction_charges": "12.00",
                        "compare_at_price": "0.00",
                        "weight": "10.00",
                        "barcode": "101",
                        "track_inventory": 1,
                        "quantity": 20,
                        "requires_shipping": 1,
                        "date_add": "2019-11-20T07:13:24+00:00",
                        "date_upd": "2019-11-20T08:24:51+00:00",
                        "charge_taxes": 1,
                        "dimension": "{\"length\":\"1\", \"width\":\"1\", \"height\":\"1\", \"girth\":\"1\"}",
                        "inventory_policy": 1,
                        "id_parent": 0,
                        "combinations": [
                            {
                                "id": 1000001,
                                "variant_id": 100001,
                                "option_value": "New"
                            }
                        ],
                        "inventory_locations": [
                            {
                                "id": 1001,
                                "product_id": 10001,
                                "variant_id": 100001,
                                "variant_quantity": 10,
                                "location_id": 11,
                                "location_name": "India",
                                "shopify_location_id": 100000000001
                            },
                            {
                                "id": 1002,
                                "product_id": 10001,
                                "variant_id": 100001,
                                "variant_quantity": 10,
                                "location_id": 12,
                                "location_name": "US",
                                "shopify_location_id": 100000000002
                            }
                        ]
                    }
                ],
                "options": [
                    {
                        "id": 101,
                        "name": "Title",
                        "product_id": 10001,
                        "values": [
                            {
                                "id": 1001,
                                "option_id": 101,
                                "value": "New"
                            }
                        ]
                    }
                ],
                "images": [
                    {
                        "id": 1000001,
                        "product_id": 10001,
                        "active": 1,
                        "position": 1,
                        "img_url": "https://example.com/test.jpg",
                        "img_sm": "https://example.com/test.jpg",
                        "img_md": "https://example.com/test.jpg",
                        "img_lg": "https://example.com/test.jpg",
                        "img_alt": "Test Product",
                        "process_status": "Processed"
                    }
                ],
                "collections": [
                    {
                        "id": 101,
                        "product_id": 10001,
                        "shopify_category_id": 1000000001,
                        "collection": {
                            "id": 1001,
                            "shopify_category_id": 1000000001,
                            "category_name": "Home page",
                            "handle": "frontpage",
                            "level": 0,
                            "id_parent": 0,
                            "active": 1
                        }
                    }
                ]
            }
        ]
    }

    GET /api/v2/products/{productId}.json

    Get product by product id

    Parameters

    Name

    productId  *required
    string
    (path)

    Description

    This is the product ID, a unique human-friendly string for the product.

    RESPONSE

    {
        "product": {
            "id": 10001,
            "main_id_shop": 101,
            "seller_id": 1001,
            "product_name": "Test Product",
            "product_type": "test",
            "product_description": "<p>product description</p>",
            "product_tag": "[\"test_tag\"]",
            "handle": "test-product",
            "product_meta_info": null,
            "price": "100.00",
            "compare_at_price": "0.00",
            "sales_price": "132.00",
            "handling_charges": "10.00",
            "transaction_charges": "12.00",
            "track_inventory": 1,
            "quantity": 20,
            "inventory_policy": 1,
            "active": 1,
            "has_default_shipping": 1,
            "has_multiple_options": 1,
            "charge_taxes": 1,
            "tax_type": null,
            "hsn": null,
            "cgst": "0.00",
            "sgst": "0.00",
            "gst": "0.00",
            "product_policy": "product_policy",
            "id_parent": 0,
            "product_url": "",
            "expiry_date": null,
            "platform": 0,
            "design_id": 0,
            "date_add": "2019-11-20T07:13:24+00:00",
            "date_upd": "2019-11-20T08:24:51+00:00",
            "type": {
                "id": 1,
                "type_name": "normal"
            },
            "variants": [
                {
                    "id": 100001,
                    "product_id": 10001,
                    "shopify_product_id": 1000000001,
                    "shopify_variant_id": 10000000001,
                    "image_id": 1000001,
                    "sku": "H101",
                    "price": "100.00",
                    "sales_price": "132.00",
                    "handling_charges": "10.00",
                    "transaction_charges": "12.00",
                    "compare_at_price": "0.00",
                    "weight": "10.00",
                    "barcode": "101",
                    "track_inventory": 1,
                    "quantity": 20,
                    "requires_shipping": 1,
                    "date_add": "2019-11-20T07:13:24+00:00",
                    "date_upd": "2019-11-20T08:24:51+00:00",
                    "charge_taxes": 1,
                    "dimension": "{\"length\":\"1\", \"width\":\"1\", \"height\":\"1\", \"girth\":\"1\"}",
                    "inventory_policy": 1,
                    "id_parent": 0,
                    "combinations": [
                        {
                            "id": 1000001,
                            "variant_id": 100001,
                            "option_value": "New"
                        }
                    ],
                    "inventory_locations": [
                        {
                            "id": 1001,
                            "product_id": 10001,
                            "variant_id": 100001,
                            "variant_quantity": 10,
                            "location_id": 11,
                            "location_name": "India",
                            "shopify_location_id": 100000000001
                        },
                        {
                            "id": 1002,
                            "product_id": 10001,
                            "variant_id": 100001,
                            "variant_quantity": 10,
                            "location_id": 12,
                            "location_name": "US",
                            "shopify_location_id": 100000000002
                        }
                    ]
                }
            ],
            "options": [
                {
                    "id": 101,
                    "name": "Title",
                    "product_id": 10001,
                    "values": [
                        {
                            "id": 1001,
                            "option_id": 101,
                            "value": "New"
                        }
                    ]
                }
            ],
            "images": [
                {
                    "id": 1000001,
                    "product_id": 10001,
                    "active": 1,
                    "position": 1,
                    "img_url": "https://example.com/test.jpg",
                    "img_sm": "https://example.com/test.jpg",
                    "img_md": "https://example.com/test.jpg",
                    "img_lg": "https://example.com/test.jpg",
                    "img_alt": "Test Product",
                    "process_status": "Processed"
                }
            ],
            "collections": [
                {
                    "id": 101,
                    "product_id": 10001,
                    "shopify_category_id": 1000000001,
                    "collection": {
                        "id": 1001,
                        "shopify_category_id": 1000000001,
                        "category_name": "Home page",
                        "handle": "frontpage",
                        "level": 0,
                        "id_parent": 0,
                        "active": 1
                    }
                }
            ]
        }
    }

    POST /api/v2/products.json

    Create/Add a new product to the store (Only works for creating normal products)

    Parameters

    Name

    Products
    json
    (body)

    Required Parameters:

    • seller_id
    • type
    • product_name
    • variants
    • price
    • options
      • name
      • values
    • track_inventory
      If track_inventory= 1
      Then these parameters are required:
    • inventory_locations
    • location_id
    • variant_quantity

    Description

    Create/Add a new product to the store

    Example Value

    {
      "seller_id": "1001",
      "type": "1",
      "product_name": "Test Product",
      "product_type": "Test",
      "product_tag": "test_tag",
      "product_description": "product description",
      "handle": "test-product",
      "product_meta_info": "meta_info",
      "product_policy": "product_policy",
      "product_url": "https://example.com/products/101",
      "expiry_date": "2019/11/15",
      "shipping_id": "1",
      "variants": [
        {
          "sku": "H101",
          "barcode": "101",
          "weight": "10",
          "dimension": "{\"length\":\"2\", \"width\":\"4\", \"height\":\"3\", \"girth\":\"1\"}",
          "price": "100.00",
          "compare_at_price": "150.00",
          "handling_charges": "10.00",
          "charge_taxes": 1,
          "require_shipping": "1",
          "track_inventory": "1",
          "quantity": "10",
          "inventory_policy": "1",
          "inventory_locations": [
            {
              "location_id": "101",
              "variant_quantity": "10"
            }
          ]
        }
      ],
      "options": [
        {
          "name": "Title",
          "values": "New"
        }
      ],
      "images": [
        {
          "image_url": "https://example.com/test.jpg",
          "image_alt": "test-image",
          "position": "0"
        }
      ],
      "collections": [
        "101", "102"
      ]
    }

    Parameter content-type: application/json

    RESPONSE

    {
        "product": {
            "id": 10001,
            "main_id_shop": 101,
            "seller_id": 1001,
            "product_name": "Test Product",
            "product_type": "test",
            "product_description": "<p>product description</p>",
            "product_tag": "[\"test_tag\"]",
            "handle": "test-product",
            "product_meta_info": null,
            "price": "100.00",
            "compare_at_price": "0.00",
            "sales_price": "132.00",
            "handling_charges": "10.00",
            "transaction_charges": "12.00",
            "track_inventory": 1,
            "quantity": 20,
            "inventory_policy": 1,
            "active": 1,
            "has_default_shipping": 1,
            "has_multiple_options": 1,
            "charge_taxes": 1,
            "tax_type": null,
            "hsn": null,
            "cgst": "0.00",
            "sgst": "0.00",
            "gst": "0.00",
            "product_policy": "product_policy",
            "id_parent": 0,
            "product_url": "https://example.com/products/101",
            "expiry_date": "2019/11/15",
            "platform": 0,
            "design_id": 0,
            "date_add": "2019-11-20T07:13:24+00:00",
            "date_upd": "2019-11-20T08:24:51+00:00",
            "type": {
                "id": 1,
                "type_name": "normal"
            },
            "variants": [
                {
                    "id": 100001,
                    "product_id": 10001,
                    "shopify_product_id": 1000000001,
                    "shopify_variant_id": 10000000001,
                    "image_id": 1000001,
                    "sku": "H101",
                    "price": "100.00",
                    "sales_price": "132.00",
                    "handling_charges": "10.00",
                    "transaction_charges": "12.00",
                    "compare_at_price": "0.00",
                    "weight": "10.00",
                    "barcode": "101",
                    "track_inventory": 1,
                    "quantity": 20,
                    "requires_shipping": 1,
                    "date_add": "2019-11-20T07:13:24+00:00",
                    "date_upd": "2019-11-20T08:24:51+00:00",
                    "charge_taxes": 1,
                    "dimension": "{\"length\":\"1\", \"width\":\"1\", \"height\":\"1\", \"girth\":\"1\"}",
                    "inventory_policy": 1,
                    "id_parent": 0,
                    "combinations": [
                        {
                            "id": 1000001,
                            "variant_id": 100001,
                            "option_value": "New"
                        }
                    ],
                    "inventory_locations": [
                        {
                            "id": 1001,
                            "product_id": 10001,
                            "variant_id": 100001,
                            "variant_quantity": 10,
                            "location_id": 11,
                            "location_name": "India",
                            "shopify_location_id": 100000000001
                        },
                        {
                            "id": 1002,
                            "product_id": 10001,
                            "variant_id": 100001,
                            "variant_quantity": 10,
                            "location_id": 12,
                            "location_name": "US",
                            "shopify_location_id": 100000000002
                        }
                    ]
                }
            ],
            "options": [
                {
                    "id": 101,
                    "name": "Title",
                    "product_id": 10001,
                    "values": [
                        {
                            "id": 1001,
                            "option_id": 101,
                            "value": "New"
                        }
                    ]
                }
            ],
            "images": [
                {
                    "id": 1000001,
                    "product_id": 10001,
                    "active": 1,
                    "position": 1,
                    "img_url": "https://example.com/test.jpg",
                    "img_sm": "https://example.com/test.jpg",
                    "img_md": "https://example.com/test.jpg",
                    "img_lg": "https://example.com/test.jpg",
                    "img_alt": "Test Product",
                    "process_status": "Processed"
                }
            ],
            "collections": [
                {
                    "id": 101,
                    "product_id": 10001,
                    "shopify_category_id": 1000000001,
                    "collection": {
                        "id": 1001,
                        "shopify_category_id": 1000000001,
                        "category_name": "Home page",
                        "handle": "frontpage",
                        "level": 0,
                        "id_parent": 0,
                        "active": 1
                    }
                }
            ]
        }
    }

    PUT /api/v2/products/{productId}.json

    Update product information by their Id (Only works for updating normal products)

    Parameters

    Name

    Product
    json
    (body)

    ⠀⠀⠀⠀

    ⠀⠀⠀⠀

    ⠀⠀⠀⠀

    ⠀⠀⠀⠀

    ⠀⠀⠀⠀

    productId *required
    string
    (path)

    Description

    Using this API, you can make changes to the product details. Remember that, no changes can be made to the variants using this API

    Example Value

    {
      "seller_id": "1001",
      "product_name": "Test Product",
      "product_type": "product type",
      "product_tag": "product tags",
      "product_description": "product description",
      "product_meta_info": "meta information",
      "product_policy": "product policy",
      "product_url": "https://example.com/products/101",
      "expiry_date": "2019/08/15"
    }

    Parameter content-type: application/json

    An unsigned 64-bit integer that’s used as a unique identifier for the product.

    RESPONSE

    {
        "product": {
            "id": 10001,
            "main_id_shop": 101,
            "seller_id": 1001,
            "product_name": "Test Product",
            "product_type": "product type",
            "product_description": "<p>product description</p>",
            "product_tag": "[\"product tags\"]",
            "handle": "test-product",
            "product_meta_info": "meta information",
            "price": "100.00",
            "compare_at_price": "0.00",
            "sales_price": "132.00",
            "handling_charges": "10.00",
            "transaction_charges": "12.00",
            "track_inventory": 1,
            "quantity": 20,
            "inventory_policy": 1,
            "active": 1,
            "has_default_shipping": 1,
            "has_multiple_options": 1,
            "charge_taxes": 1,
            "tax_type": null,
            "hsn": null,
            "cgst": "0.00",
            "sgst": "0.00",
            "gst": "0.00",
            "product_policy": "product policy",
            "id_parent": 0,
            "product_url": "",
            "expiry_date": null,
            "platform": 0,
            "design_id": 0,
            "date_add": "2019-11-20T07:13:24+00:00",
            "date_upd": "2019-11-20T08:24:51+00:00",
            "type": {
                "id": 1,
                "type_name": "normal"
            },
            "variants": [
                {
                    "id": 100001,
                    "product_id": 10001,
                    "image_id": 1000001,
                    "shopify_product_id": 1000000001,
                    "shopify_variant_id": 10000000001,
                    "sku": "H101",
                    "price": "100.00",
                    "sales_price": "132.00",
                    "handling_charges": "10.00",
                    "transaction_charges": "12.00",
                    "compare_at_price": "0.00",
                    "weight": "10.00",
                    "barcode": "101",
                    "track_inventory": 1,
                    "quantity": 20,
                    "requires_shipping": 1,
                    "date_add": "2019-11-20T07:13:24+00:00",
                    "date_upd": "2019-11-20T08:24:51+00:00",
                    "charge_taxes": 1,
                    "dimension": "{\"length\":\"1\", \"width\":\"1\", \"height\":\"1\", \"girth\":\"1\"}",
                    "inventory_policy": 1,
                    "id_parent": 0,
                    "combinations": [
                        {
                            "id": 1000001,
                            "variant_id": 100001,
                            "option_value": "New"
                        }
                    ],
                    "inventory_locations": [
                        {
                            "id": 1001,
                            "product_id": 10001,
                            "variant_id": 100001,
                            "variant_quantity": 10,
                            "location_id": 11,
                            "location_name": "India",
                            "shopify_location_id": 100000000001
                        },
                        {
                            "id": 1002,
                            "product_id": 10001,
                            "variant_id": 100001,
                            "variant_quantity": 10,
                            "location_id": 12,
                            "location_name": "US",
                            "shopify_location_id": 100000000002
                        }
                    ]
                }
            ],
            "options": [
                {
                    "id": 101,
                    "name": "Title",
                    "product_id": 10001,
                    "values": [
                        {
                            "id": 1001,
                            "option_id": 101,
                            "value": "New"
                        }
                    ]
                }
            ],
            "images": [
                {
                    "id": 1000001,
                    "product_id": 10001,
                    "active": 1,
                    "position": 1,
                    "img_url": "https://example.com/test.jpg",
                    "img_sm": "https://example.com/test.jpg",
                    "img_md": "https://example.com/test.jpg",
                    "img_lg": "https://example.com/test.jpg",
                    "img_alt": "Test Product",
                    "process_status": "Processed"
                }
            ],
            "collections": [
                {
                    "id": 101,
                    "product_id": 10001,
                    "shopify_category_id": 1000000001,
                    "collection": {
                        "id": 1001,
                        "shopify_category_id": 1000000001,
                        "category_name": "Home page",
                        "handle": "frontpage",
                        "level": 0,
                        "id_parent": 0,
                        "active": 1
                    }
                }
            ]
        }
    }

    DELETE /api/v2/products/{productId}.json

    Delete product by product id

    Parameters

    Name

    productId *required
    string
    (path)

    Description

    An unsigned 64-bit integer that’s used as a unique identifier for the product.

    RESPONSE

    [
    product had been deleted
    
    ]

    DELETE /api/v2/products/{productId}/variants/{variantId}.json

    Delete product variant by product id & variant id

    Parameters

    Name

    productId *required
    string
    (path)

    variantId *required
    string
    (path)

    Description

    An unsigned 64-bit integer that’s used as a unique identifier for the product.

    An unsigned 64-bit integer that’s used as a unique identifier for the variant.

    RESPONSE

    [
    
    Product variant had beed deleted
    
    ]

    POST /api/v2/products/{productId}/variants.json

    Create/Add a new variant for a product

    Parameters

    Name

    Variants
    json
    (body)

    productId *required
    string
    (path)

    Description

    Using this API, you can make changes to the variant details.

    Example Value

    {
      "image_id": "1000001",
      "sku": "H101",
      "barcode": "101",
      "weight": "10",
      "dimension": "{\"length\":\"1\", \"width\":\"1\", \"height\":\"1\", \"girth\":\"1\"}",
      "option1": "New",
      "option2": "",
      "option3": "",
      "price": "100.00",
      "compare_at_price": "150.00",
      "handling_charges": "10.00",
      "charge_taxes": "1",
      "require_shipping": "1",
      "track_inventory": "1",
      "quantity": "10",
      "inventory_policy": "true",
      "inventory_locations": [
        {
          "location_id": "11",
          "variant_quantity": "10"
        }
      ]
    }

    RESPONSE

    {
        "product": {
            "id": 10001,
            "main_id_shop": 101,
            "seller_id": 1001,
            "product_name": "Test Product",
            "product_type": "product type",
            "product_description": "<p>product description</p>",
            "product_tag": "[\"product tags\"]",
            "handle": "test-product",
            "product_meta_info": "meta information",
            "price": "100.00",
            "compare_at_price": "0.00",
            "sales_price": "132.00",
            "handling_charges": "10.00",
            "transaction_charges": "12.00",
            "track_inventory": 1,
            "quantity": 30,
            "inventory_policy": 1,
            "active": 1,
            "has_default_shipping": 1,
            "has_multiple_options": 1,
            "charge_taxes": 1,
            "tax_type": null,
            "hsn": null,
            "cgst": "0.00",
            "sgst": "0.00",
            "gst": "0.00",
            "product_policy": "product policy",
            "id_parent": 0,
            "product_url": "",
            "expiry_date": null,
            "platform": 0,
            "design_id": 0,
            "date_add": "2019-11-20T07:13:24+00:00",
            "date_upd": "2019-11-20T08:24:51+00:00",
            "type": {
                "id": 1,
                "type_name": "normal"
            },
            "variants": [
                {
                    "id": 100001,
                    "product_id": 10001,
                    "image_id": 1000001,
                    "shopify_product_id": 1000000001,
                    "shopify_variant_id": 10000000001,
                    "sku": "H101",
                    "price": "100.00",
                    "sales_price": "132.00",
                    "handling_charges": "10.00",
                    "transaction_charges": "12.00",
                    "compare_at_price": "0.00",
                    "weight": "10.00",
                    "barcode": "101",
                    "track_inventory": 1,
                    "quantity": 20,
                    "requires_shipping": 1,
                    "date_add": "2019-11-20T07:13:24+00:00",
                    "date_upd": "2019-11-20T08:24:51+00:00",
                    "charge_taxes": 1,
                    "dimension": "{\"length\":\"1\", \"width\":\"1\", \"height\":\"1\", \"girth\":\"1\"}",
                    "inventory_policy": 1,
                    "id_parent": 0,
                    "combinations": [
                        {
                            "id": 1000001,
                            "variant_id": 100001,
                            "option_value": "New"
                        }
                    ],
                    "inventory_locations": [
                        {
                            "id": 1001,
                            "product_id": 10001,
                            "variant_id": 100001,
                            "variant_quantity": 10,
                            "location_id": 11,
                            "location_name": "India",
                            "shopify_location_id": 100000000001
                        },
                        {
                            "id": 1002,
                            "product_id": 10001,
                            "variant_id": 100001,
                            "variant_quantity": 10,
                            "location_id": 12,
                            "location_name": "US",
                            "shopify_location_id": 100000000002
                        }
                    ]
                },
                {
                    "id": 100002,
                    "product_id": 10001,
                    "image_id": 1000001,
                    "shopify_product_id": 1000000001,
                    "shopify_variant_id": 10000000002,
                    "sku": "H101",
                    "price": "100.00",
                    "sales_price": "132.00",
                    "handling_charges": "10.00",
                    "transaction_charges": "12.00",
                    "compare_at_price": "150.00",
                    "weight": "10.00",
                    "barcode": "101",
                    "track_inventory": 1,
                    "quantity": 10,
                    "requires_shipping": 1,
                    "date_add": "2019-11-20T07:13:24+00:00",
                    "date_upd": "2019-11-20T08:24:51+00:00",
                    "charge_taxes": 1,
                    "dimension": "{\"length\":\"1\", \"width\":\"1\", \"height\":\"1\", \"girth\":\"1\"}",
                    "inventory_policy": 1,
                    "id_parent": 0,
                    "combinations": [
                        {
                            "id": 1000002,
                            "variant_id": 100002,
                            "option_value": "Old"
                        }
                    ],
                    "inventory_locations": [
                        {
                            "id": 1003,
                            "product_id": 10001,
                            "variant_id": 100002,
                            "variant_quantity": 10,
                            "location_id": 11,
                            "location_name": "India",
                            "shopify_location_id": 100000000001
                        }
                    ]
                }
            ],
            "options": [
                {
                    "id": 101,
                    "name": "Title",
                    "product_id": 10001,
                    "values": [
                        {
                            "id": 1001,
                            "option_id": 101,
                            "value": "New"
                        },
                        {
                            "id": 1002,
                            "option_id": 101,
                            "value": "Old"
                        }
                    ]
                }
            ],
            "images": [
                {
                    "id": 1000001,
                    "product_id": 10001,
                    "active": 1,
                    "position": 1,
                    "img_url": "https://example.com/test.jpg",
                    "img_sm": "https://example.com/test.jpg",
                    "img_md": "https://example.com/test.jpg",
                    "img_lg": "https://example.com/test.jpg",
                    "img_alt": "Test Product",
                    "process_status": "Processed"
                }
            ],
            "collections": [
                {
                    "id": 101,
                    "product_id": 10001,
                    "shopify_category_id": 1000000001,
                    "collection": {
                        "id": 1001,
                        "shopify_category_id": 1000000001,
                        "category_name": "Home page",
                        "handle": "frontpage",
                        "level": 0,
                        "id_parent": 0,
                        "active": 1
                    }
                }
            ]
        }
    }

    GET /api/v2/products/{productId}/variants/{variantId}.json

    Get variant by product id & variant id

    Parameters

    Name

    productId *required
    string
    (path)

    variantId *required
    string
    (path)

    Description

    An unsigned 64-bit integer that’s used as a unique identifier for the product.

    An unsigned 64-bit integer that’s used as a unique identifier for the variant.

    RESPONSE

    {        
        "variant": {
            "id": 100001,
            "product_id": 10001,
            "image_id": 1000001,
            "shopify_product_id": 1000000001,
            "shopify_variant_id": 10000000001,
            "sku": "H101",
            "price": "100.00",
            "sales_price": "132.00",
            "handling_charges": "10.00",
            "transaction_charges": "12.00",
            "compare_at_price": "0.00",
            "weight": "10.00",
            "barcode": "101",
            "track_inventory": 1,
            "quantity": 20,
            "requires_shipping": 1,
            "date_add": "2019-11-20T07:13:24+00:00",
            "date_upd": "2019-11-20T08:24:51+00:00",
            "charge_taxes": 1,
            "dimension": "{\"length\":\"1\", \"width\":\"1\", \"height\":\"1\", \"girth\":\"1\"}",
            "inventory_policy": 1,
            "id_parent": 0,
            "combinations": [
                {
                    "id": 1000001,
                    "variant_id": 100001,
                    "option_value": "New"
                }
            ],
            "inventory_locations": [
                {
                    "id": 1001,
                    "product_id": 10001,
                    "variant_id": 100001,
                    "variant_quantity": 10,
                    "location_id": 11,
                    "location_name": "India",
                    "shopify_location_id": 100000000001
                },
                {
                    "id": 1002,
                    "product_id": 10001,
                    "variant_id": 100001,
                    "variant_quantity": 10,
                    "location_id": 12,
                    "location_name": "US",
                    "shopify_location_id": 100000000002
                }
            ]
        }
    }

    GET /api/v2/products/{productId}/variants.json

    Get all variants by product id

    Parameters

    Name

    productId *required
    string
    (path)

    Description

    An unsigned 64-bit integer that’s used as a unique identifier for the product.

    RESPONSE

    {        
        "variants": [
            {
                "id": 100001,
                "product_id": 10001,
                "image_id": 1000001,
                "shopify_product_id": 1000000001,
                "shopify_variant_id": 10000000001,
                "sku": "H101",
                "price": "100.00",
                "sales_price": "132.00",
                "handling_charges": "10.00",
                "transaction_charges": "12.00",
                "compare_at_price": "0.00",
                "weight": "10.00",
                "barcode": "101",
                "track_inventory": 1,
                "quantity": 20,
                "requires_shipping": 1,
                "date_add": "2019-11-20T07:13:24+00:00",
                "date_upd": "2019-11-20T08:24:51+00:00",
                "charge_taxes": 1,
                "dimension": "{\"length\":\"1\", \"width\":\"1\", \"height\":\"1\", \"girth\":\"1\"}",
                "inventory_policy": 1,
                "id_parent": 0,
                "combinations": [
                    {
                        "id": 1000001,
                        "variant_id": 100001,
                        "option_value": "New"
                    }
                ],
                "inventory_locations": [
                    {
                        "id": 1001,
                        "product_id": 10001,
                        "variant_id": 100001,
                        "variant_quantity": 10,
                        "location_id": 11,
                        "location_name": "India",
                        "shopify_location_id": 100000000001
                    },
                    {
                        "id": 1002,
                        "product_id": 10001,
                        "variant_id": 100001,
                        "variant_quantity": 10,
                        "location_id": 12,
                        "location_name": "US",
                        "shopify_location_id": 100000000002
                    }
                ]
            },
            {
                "id": 100002,
                "product_id": 10001,
                "image_id": 1000001,
                "shopify_product_id": 1000000001,
                "shopify_variant_id": 10000000002,
                "sku": "H101",
                "price": "100.00",
                "sales_price": "132.00",
                "handling_charges": "10.00",
                "transaction_charges": "12.00",
                "compare_at_price": "150.00",
                "weight": "10.00",
                "barcode": "101",
                "track_inventory": 1,
                "quantity": 10,
                "requires_shipping": 1,
                "date_add": "2019-11-20T07:13:24+00:00",
                "date_upd": "2019-11-20T08:24:51+00:00",
                "charge_taxes": 1,
                "dimension": "{\"length\":\"1\", \"width\":\"1\", \"height\":\"1\", \"girth\":\"1\"}",
                "inventory_policy": 1,
                "id_parent": 0,
                "combinations": [
                    {
                        "id": 1000002,
                        "variant_id": 100002,
                        "option_value": "Old"
                    }
                ],
                "inventory_locations": [
                    {
                        "id": 1003,
                        "product_id": 10001,
                        "variant_id": 100002,
                        "variant_quantity": 10,
                        "location_id": 11,
                        "location_name": "India",
                        "shopify_location_id": 100000000001
                    }
                ]
            }
        ]
    }

    GET /api/v2/products/{productId}/images.json

    Get all images by product id

    Parameters

    Name

    productId *required
    string
    (path)

    Description

    An unsigned 64-bit integer that’s used as a unique identifier for the product.

    RESPONSE

    {        
        "images": [
            {
                "id": 1000001,
                "product_id": 10001,
                "active": 1,
                "position": 1,
                "img_url": "https://example.com/test.jpg",
                "img_sm": "https://example.com/test.jpg",
                "img_md": "https://example.com/test.jpg",
                "img_lg": "https://example.com/test.jpg",
                "img_alt": "Test Product",
                "process_status": "Processed"
            }
        ]
    }

    GET /api/v2/products/{productId}/collections.json

    Get all collections by product id

    Parameters

    Name

    productId *required
    string
    (path)

    Description

    An unsigned 64-bit integer that’s used as a unique identifier for the product.

    RESPONSE

    {        
        "collections": [
            {
                "id": 101,
                "product_id": 10001,
                "shopify_category_id": 1000000001,
                "collection": {
                    "id": 1001,
                    "shopify_category_id": 1000000001,
                    "category_name": "Home page",
                    "handle": "frontpage",
                    "level": 0,
                    "id_parent": 0,
                    "active": 1
                }
            }
        ]
    }

    PUT /api/v2/products/{productId}/variants/{variantId}.json

    Update variant by product id & variant id

    Parameters

    Name

    productId *required
    string
    (path)

    variantId *required
    string
    (path)

    Variants
    json
    (body)

    Description

    An unsigned 64-bit integer that’s used as a unique identifier for the product.

    An unsigned 64-bit integer that’s used as a unique identifier for the variant.

    Using this API, you can make changes to the variant details.

    Example Value

    {
      "image_id": "1000001",
      "sku": "H101",
      "barcode": "101",
      "weight": "10",
      "dimension": "{\"length\":\"1\", \"width\":\"1\", \"height\":\"1\", \"girth\":\"1\"}",
      "option1": "New",
      "option2": "",
      "option3": "",
      "price": "100.00",
      "compare_at_price": "150.00",
      "handling_charges": "10.00",
      "charge_taxes": "1",
      "require_shipping": "1",
      "track_inventory": "1",
      "quantity": "10",
      "inventory_policy": "true",
      "inventory_locations": [
        {
          "location_id": "11",
          "variant_quantity": "10"
        }
      ]
    }

    RESPONSE

    {
        "product": {
            "id": 10001,
            "main_id_shop": 101,
            "seller_id": 1001,
            "product_name": "Test Product",
            "product_type": "product type",
            "product_description": "<p>product description</p>",
            "product_tag": "[\"product tags\"]",
            "handle": "test-product",
            "product_meta_info": "meta information",
            "price": "100.00",
            "compare_at_price": "0.00",
            "sales_price": "132.00",
            "handling_charges": "10.00",
            "transaction_charges": "12.00",
            "track_inventory": 1,
            "quantity": 20,
            "inventory_policy": 1,
            "active": 1,
            "has_default_shipping": 1,
            "has_multiple_options": 1,
            "charge_taxes": 1,
            "tax_type": null,
            "hsn": null,
            "cgst": "0.00",
            "sgst": "0.00",
            "gst": "0.00",
            "product_policy": "product policy",
            "id_parent": 0,
            "product_url": "",
            "expiry_date": null,
            "platform": 0,
            "design_id": 0,
            "date_add": "2019-11-20T07:13:24+00:00",
            "date_upd": "2019-11-20T08:24:51+00:00",
            "type": {
                "id": 1,
                "type_name": "normal"
            },
            "variants": [
                {
                    "id": 100001,
                    "product_id": 10001,
                    "image_id": 1000001,
                    "shopify_product_id": 1000000001,
                    "shopify_variant_id": 10000000001,
                    "sku": "H101",
                    "price": "100.00",
                    "sales_price": "132.00",
                    "handling_charges": "10.00",
                    "transaction_charges": "12.00",
                    "compare_at_price": "0.00",
                    "weight": "10.00",
                    "barcode": "101",
                    "track_inventory": 1,
                    "quantity": 10,
                    "requires_shipping": 1,
                    "date_add": "2019-11-20T07:13:24+00:00",
                    "date_upd": "2019-11-20T08:24:51+00:00",
                    "charge_taxes": 1,
                    "dimension": "{\"length\":\"1\", \"width\":\"1\", \"height\":\"1\", \"girth\":\"1\"}",
                    "inventory_policy": 1,
                    "id_parent": 0,
                    "combinations": [
                        {
                            "id": 1000001,
                            "variant_id": 100001,
                            "option_value": "New"
                        }
                    ],
                    "inventory_locations": [
                        {
                            "id": 1001,
                            "product_id": 10001,
                            "variant_id": 100001,
                            "variant_quantity": 10,
                            "location_id": 11,
                            "location_name": "India",
                            "shopify_location_id": 100000000001
                        }
                    ]
                },
                {
                    "id": 100002,
                    "product_id": 10001,
                    "image_id": 1000001,
                    "shopify_product_id": 1000000001,
                    "shopify_variant_id": 10000000002,
                    "sku": "H101",
                    "price": "100.00",
                    "sales_price": "132.00",
                    "handling_charges": "10.00",
                    "transaction_charges": "12.00",
                    "compare_at_price": "150.00",
                    "weight": "10.00",
                    "barcode": "101",
                    "track_inventory": 1,
                    "quantity": 10,
                    "requires_shipping": 1,
                    "date_add": "2019-11-20T07:13:24+00:00",
                    "date_upd": "2019-11-20T08:24:51+00:00",
                    "charge_taxes": 1,
                    "dimension": "{\"length\":\"1\", \"width\":\"1\", \"height\":\"1\", \"girth\":\"1\"}",
                    "inventory_policy": 1,
                    "id_parent": 0,
                    "combinations": [
                        {
                            "id": 1000002,
                            "variant_id": 100002,
                            "option_value": "Old"
                        }
                    ],
                    "inventory_locations": [
                        {
                            "id": 1003,
                            "product_id": 10001,
                            "variant_id": 100002,
                            "variant_quantity": 10,
                            "location_id": 11,
                            "location_name": "India",
                            "shopify_location_id": 100000000001
                        }
                    ]
                }
            ],
            "options": [
                {
                    "id": 101,
                    "name": "Title",
                    "product_id": 10001,
                    "values": [
                        {
                            "id": 1001,
                            "option_id": 101,
                            "value": "New"
                        },
                        {
                            "id": 1002,
                            "option_id": 101,
                            "value": "Old"
                        }
                    ]
                }
            ],
            "images": [
                {
                    "id": 1000001,
                    "product_id": 10001,
                    "active": 1,
                    "position": 1,
                    "img_url": "https://example.com/test.jpg",
                    "img_sm": "https://example.com/test.jpg",
                    "img_md": "https://example.com/test.jpg",
                    "img_lg": "https://example.com/test.jpg",
                    "img_alt": "Test Product",
                    "process_status": "Processed"
                }
            ],
            "collections": [
                {
                    "id": 101,
                    "product_id": 10001,
                    "shopify_category_id": 1000000001,
                    "collection": {
                        "id": 1001,
                        "shopify_category_id": 1000000001,
                        "category_name": "Home page",
                        "handle": "frontpage",
                        "level": 0,
                        "id_parent": 0,
                        "active": 1
                    }
                }
            ]
        }
    }
    {        
        "collections": [
            {
                "id": 101,
                "product_id": 10001,
                "shopify_category_id": 1000000001,
                "collection": {
                    "id": 1001,
                    "shopify_category_id": 1000000001,
                    "category_name": "Home page",
                    "handle": "frontpage",
                    "level": 0,
                    "id_parent": 0,
                    "active": 1
                }
            }
        ]
    }
    {        
        "collections": [
            {
                "id": 101,
                "product_id": 10001,
                "shopify_category_id": 1000000001,
                "collection": {
                    "id": 1001,
                    "shopify_category_id": 1000000001,
                    "category_name": "Home page",
                    "handle": "frontpage",
                    "level": 0,
                    "id_parent": 0,
                    "active": 1
                }
            }
        ]
    }

    GET/api/v2/public/products/count.json

    Get count of all products

    Parameters

    Name

    Shop name *required
    string
    (path)

    filter
    string
    (query)

    Description

    Searches only for the store with the specified store name.



    Searches only for the products with the specified ‘seller_id’, ‘type’, ‘product_status’ . (Example: {“sellerId”:”1234″, “type”:”normal”,”status”:”Active, Disabled, Denied, Approval Pending, Reapproved”})

    RESPONSE

    {
      "product_count": "33"
    }

    GET/api/v2/public/products.json

    Get all products

    Parameters

    Name

    limit integer
    string
    (query)

    sort_by
    string
    (query)


    sort_order
    string
    (query)

    Filter
    string
    (query)



    shop_name
    string
    (query)

    Description

    Return up to this many results per page. (maximum: 250)

    Default value: 50

    Determines the parameter by which the products are sorted in the response. Available parameters are id, product_name, seller_id, price, quantity, date_add.

    Default value : date_add


    Determines the sorting order. 1).asc-> ascending 2).desc-> descending

    Default value : desc

    Searches only for the products with the specified ‘id’, ‘product_name’, ‘id_shop’, ‘price’, ‘type’, ‘handle’, ‘product_type’, ‘platform’, ‘product_id_lt’ (product id less than), ‘product_id_gt’ (product id greater than). (Example: {“id”:”10001″, “product_name”:”White Shirt”, “id_shop”:”10001″, “type”:”1″, “platform”:”2″, “date_from”:”2020-01-01 01:59:59″, “date_to”:”2020-01-01 11:59:59″})


    Determines the parameter by which the products are filter in the response.

    RESPONSE

    {
      "products": [
        {
          "id": 51043,
          "product_name": "rajan Product2",
          "shopify_product_id": 0,
          "handle": "test",
          "price": "100.00",
          "product_policy": "product_policy",
          "custom_fields": [],
          "images": "https://example.com/example.png",
          "review_avg": "0.0"
        },
        {
          "id": 51042,
          "product_name": "rajan Product2",
          "shopify_product_id": 0,
          "handle": "test",
          "price": "100.00",
          "product_policy": "product_policy",
          "custom_fields": [],
          "images": "https://example.com/example.png",
          "review_avg": "0.0"
        }
      ]
    }

    GET/api/v2/public/hyperlocal/products.json

    Get all hyperlocal product

    Parameters

    Name

    limit
    integer
    (query)

    sort_by
    string
    (query)

    sort_order
    string
    (query)

    filter
    string
    (query)



    shop_name *required
    string
    (query)

    seller ids * required
    string
    (query)

    page
    string
    (query)

    Description

    Return up to this many results per page. (maximum: 250)
    Default value : 50

    Determines the parameter by which the products are sorted in the response. Available parameters are id, product_name, seller_id, price, quantity, date_add.
    Default value : date_add

    Determines the sorting order. 1).asc-> ascending 2).desc-> descending
    Default value : desc


    Searches only for the products with the specified ‘id’, ‘product_name’, ‘id_shop’, ‘price’, ‘type’, ‘handle’, ‘product_type’, ‘platform’, ‘productTag’, ‘productType’, ‘mainIdCategory’ (category filter by main id). (Example: {“id”:”10001″, “product_name”:”White Shirt”, “id_shop”:”10001″, “type”:”1″, “platform”:”2″, “date_from”:”2020-01-01 01:59:59″, “date_to”:”2020-01-01 11:59:59″, “main_id_category”:”264492613676″})


    Determines the parameter by which the products are filter in the response.



    Determines the parameter by which the products are filter in the response.



    Return up to this many results current page.

    Default value : 1

    RESPONSE

        {
      "products": [
        {
          "id": "51017",
          "product_name": "Test Product",
          "handle": "test",
          "price": "100.00",
          "product_policy": "product_policy",
          "id_shop": 4303,
          "quantity": "0",
          "images": "https://example.com/example.png"
        }
      ]
    }

    GET/api/v2/public/hyperlocal/products/count.json

    Get count of all hyperlocal products

    Parameters

    Name

    shop_name *required
    string
    (query)


    filter
    string
    (query)




    seller ids * required
    string
    (query)

    Description

    Searches only for the store with the specified store name.

    Searches only for the products with the specified ‘id’, ‘product_name’, ‘id_shop’, ‘price’, ‘type’, ‘handle’, ‘product_type’, ‘platform’, ‘productTag’, ‘productType’, ‘mainIdCategory’ (category filter by main id). (Example: {“id”:”10001″, “product_name”:”White Shirt”, “id_shop”:”10001″, “type”:”1″, “platform”:”2″, “date_from”:”2020-01-01 01:59:59″, “date_to”:”2020-01-01 11:59:59″, “main_id_category”:”264492613676″})


    Filter response by seller ids separated by comma.

    RESPONSE

    {
      "products_count": 1
    }

    GET /api/v2/products/count.json

    Get count of all products

    Parameters

    Name

    seller_id
    string
    (query)


    filter
    string
    (query)

    Description

    Filter response by seller id

    Count Products with their ‘type’, 1 for normal, 2 for digital, 3 for global product or with platform id ,’platform_id’, 2:’Woo-commerce’, 3:’Etsy’, 4:’Magento’, 5:’Prestashop’. (Example: {“type”:”1″, “platform”:”2″})

    RESPONSE

    {
      "count": 33
    }

    PUT /api/v2/products/{productId}/collections.json

    Update product collections by product id

    Parameters

    Name

    productId *required
    string
    (path)

    Products collections
    json
    (body)

    Description

    MVM product ID

    An unsigned 64-bit integer that’s used as a unique identifier for the variant.

    RESPONSE

    Request:
    {
      "collections": [
          1655
      ]
    }
    
    Response:
    {
        "products": {
            "id": 51029,
            "main_id_shop": 274,
            "seller_id": 4303,
            "shopify_product_id": 0,
            "product_name": "Product2",
            "product_type": "Wood",
            "product_description": "product description",
            "product_tag": "[\"electronics\"]",
            "handle": "test",
            "product_meta_info": "meta_info",
            "price": "100.00",
            "compare_at_price": "150.00",
            "sales_price": "-1.00",
            "handling_charges": "10.00",
            "transaction_charges": "0.00",
            "track_inventory": 1,
            "quantity": 10,
            "min_purchase_quantity": 0,
            "inventory_policy": 0,
            "active": 0,
            "is_re_approval": null,
            "has_default_shipping": 1,
            "has_multiple_options": 1,
            "charge_taxes": 1,
            "tax_type": null,
            "hsn": null,
            "cgst": "0.00",
            "sgst": "0.00",
            "gst": "0.00",
            "product_policy": "product_policy",
            "id_parent": 0,
            "product_url": "https://example.com/products/101",
            "ref_product_id": "0",
            "custom_fields": null,
            "expiry_date": null,
            "platform": 0,
            "design_id": 0,
            "date_add": "2022-03-25T13:20:32+00:00",
            "date_upd": "2022-03-28T06:06:27+00:00",
            "type": {
                "id": 1,
                "type_name": "normal"
            },
            "variants": [
                {
                    "id": 73899,
                    "product_id": 51029,
                    "shopify_product_id": 0,
                    "shopify_variant_id": 0,
                    "image_id": 0,
                    "sku": "H101",
                    "price": "100.00",
                    "sales_price": "-1.00",
                    "handling_charges": "10.00",
                    "transaction_charges": "0.00",
                    "compare_at_price": "150.00",
                    "weight": "10.00",
                    "barcode": "101",
                    "track_inventory": 1,
                    "quantity": 5,
                    "requires_shipping": 1,
                    "date_add": "2022-03-25T13:20:32+00:00",
                    "date_upd": null,
                    "charge_taxes": 0,
                    "dimension": "{\"length\":\"1\", \"width\":\"1\", \"height\":\"1\", \"girth\":\"1\"}",
                    "inventory_policy": 0,
                    "id_parent": 0,
                    "combinations": [
                        {
                            "id": 144737,
                            "variant_id": 73899,
                            "option_value": "New"
                        }
                    ],
                    "inventory_locations": [
                        {
                            "id": 25322,
                            "product_id": 51029,
                            "variant_id": 73899,
                            "shopify_inventory_item_id": 0,
                            "variant_quantity": 10,
                            "location_id": 1342,
                            "location_name": "Store 1",
                            "shopify_location_id": 0
                        }
                    ]
                }
            ],
            "options": [
                {
                    "id": 82521,
                    "name": "Title",
                    "product_id": 51029,
                    "values": [
                        {
                            "id": 97482,
                            "option_id": 82521,
                            "value": "New"
                        }
                    ]
                }
            ],
            "images": [
                {
                    "id": 53941,
                    "product_id": 51029,
                    "active": 0,
                    "position": 0,
                    "img_url": "https://example.com/example.png",
                    "img_sm": "https://example.com/example.png",
                    "img_md": "https://example.com/example.png",
                    "img_lg": "https://example.com/example.png",
                    "img_alt": "test-image",
                    "process_status": "Processed"
                },
                {
                    "id": 53942,
                    "product_id": 51029,
                    "active": 0,
                    "position": 0,
                    "img_url": "https://example.com/example.png",
                    "img_sm": "https://example.com/example.png",
                    "img_md": "https://example.com/example.png",
                    "img_lg": "https://example.com/example.png",
                    "img_alt": "test-image",
                    "process_status": "In-Process"
                },
                {
                    "id": 53943,
                    "product_id": 51029,
                    "active": 0,
                    "position": 0,
                    "img_url": "https://example.com/example.png",
                    "img_sm": "https://example.com/example.png",
                    "img_md": "https://example.com/example.png",
                    "img_lg": "https://example.com/example.png",
                    "img_alt": "test-image",
                    "process_status": "In-Process"
                },
                {
                    "id": 53944,
                    "product_id": 51029,
                    "active": 0,
                    "position": 0,
                    "img_url": "https://example.com/example.png",
                    "img_sm": "https://example.com/example.png",
                    "img_md": "https://example.com/example.png",
                    "img_lg": "https://example.com/example.png",
                    "img_alt": "test-image",
                    "process_status": "In-Process"
                },
                {
                    "id": 53945,
                    "product_id": 51029,
                    "active": 0,
                    "position": 0,
                    "img_url": "https://example.com/example.png",
                    "img_sm": "https://example.com/example.png",
                    "img_md": "https://example.com/example.png",
                    "img_lg": "https://example.com/example.png",
                    "img_alt": "test-image",
                    "process_status": "In-Process"
                }
            ],
            "collections": [
                {
                    "id": 22130,
                    "product_id": 51029,
                    "shopify_category_id": 392181907693,
                    "collection": {
                        "id": 1655,
                        "shopify_category_id": 392181907693,
                        "category_name": "Home page",
                        "handle": "frontpage",
                        "level": 0,
                        "id_parent": 0,
                        "active": 1
                    }
                }
            ],
            "origin_country": null,
            "raise_query": 0
        }
    }

    DELETE/api/v2/products/{productId}/images.json

    Delete product image by product id

    Parameters

    Name

    productId *required
    string
    (path)

    Description

    An unsigned 64-bit integer that’s used as a unique identifier for the product.

    RESPONSE

    {
      "product": "Product image has been deleted successfully"
    }

    GET/api/v2/products/{productId}/custom-fields.json

    Get product custom fields by product id

    Parameters

    Name

    productId *required
    string
    (path)

    Description

    410

    RESPONSE

    {
      "custom_fields": [
        {
          "id": 410,
          "type_name": "text",
          "display_name": "Test field",
          "key": "cus_test_field",
          "value": "Test field"
        }
      ]
    }

    PUT/api/v2/products/{productId}/custom-fields.json

    Update/Add custom fields for product

    Parameters

    Name

    productId *required
    string
    (path)

    Description

    410

    RESPONSE

    Request:
    {
      "custom_fields": [
        {
          "id": "410",
          "value": "Color"
        }
      ]
    }
    
    Response:
    {
      "custom_fields": {
        "410": {
          "type_name": "text",
          "value": "Color",
          "display_name": "Test field",
          "key": "cus_test_field"
        }
      }
    }

    GET/api/v2/products/tags.json

    Get product tags

    Parameters

    Name

    Page
    integer
    (query)

    limit
    integer
    (integer)

    sort_by
    string
    (query)

    store_order
    string
    (query)

    Description

    Return a specific page of results.

    Default value : 1


    Return up to this many results per page. (maximum: 250)

    Default value: 50

    Determines the parameter by which the products are sorted in the response.

    Default value : date_add

    Determines the sorting order. 1).asc-> ascending 2).desc-> descending

    Default value : desc


    RESPONSE

    {
      "total_count": "1",
      "tags": [
        {
          "id": 244492,
          "main_id_shop": 41097,
          "tag_name": "test tag",
          "active": 1,
          "date_add": "2022-04-14T05:17:33+00:00",
          "date_upd": "-0001-11-30T00:00:00+00:00"
        }
      ]
    }

    GET/api/v2/products/types.json

    Get product type

    Parameters

    Name

    Page
    integer
    (query)

    limit
    integer
    (query)


    sort_by
    string
    (query)


    sort_order
    string
    (query)

    Description

    Return a specific page of results.

    Default value : 1


    Return up to this many results per page. (maximum: 250)

    Default value : 50


    Determines the parameter by which the products are sorted in the response.

    Default value : date_add


    Determines the sorting order. 1).asc-> ascending 2).desc-> descending

    Default value : desc

    RESPONSE

    {
      "total_count": "1",
      "type": [
        {
          "id": 761,
          "main_id_shop": 274,
          "type_name": "Wood",
          "active": 1,
          "date_add": "2021-11-30T09:40:03+00:00",
          "date_upd": "-0001-11-30T00:00:00+00:00"
        }
      ]
    }

    GET/api/v2/products/collections.json

    Get product collection

    Parameters

    Name

    Page
    integer
    (query)

    limit
    integer
    (query)


    sort_by
    string
    (query)



    sort_order
    string
    (query)

    Description

    Return a specific page of results.

    Default value : 1


    Return up to this many results per page. (maximum: 250)

    Default value : 50

    Determines the parameter by which the products are sorted in the response.

    Default value : date_add

    Determines the sorting order. 1).asc-> ascending 2).desc-> descending
    Default value : desc

    RESPONSE

    {
      "total_count": 2,
      "collections": [
        {
          "id": 1659,
          "main_id_shop": 274,
          "main_id_category": 398962557165,
          "category_name": "New Gen Products",
          "handle": "new-gen-products",
          "level": 0,
          "id_parent": 0,
          "date_add": "2022-03-25T13:19:34+00:00",
          "date_upd": "2022-03-25T13:19:34+00:00",
          "active": 1,
          "taxjar_product_category": null,
          "type": "custom"
        },
        {
          "id": 1655,
          "main_id_shop": 274,
          "main_id_category": 392181907693,
          "category_name": "Home page",
          "handle": "frontpage",
          "level": 0,
          "id_parent": 0,
          "date_add": "2021-11-30T09:04:10+00:00",
          "date_upd": "2021-12-06T04:55:09+00:00",
          "active": 1,
          "taxjar_product_category": null,
          "type": "custom"
        }
      ]
    }

    DELETE/api/v2/products/{productId}/variants/{variantId}/images/{imageId}.json

    Delete images of variant by image id

    Parameters

    Name

    productId *required
    string
    (path)

    variantId *required
    string
    (path)

    imageId
    string
    (path)

    Description

    8530926

    73885

    #12238

    RESPONSE

    {
      "response": "Image has been deleted"
    }

    GET/api/v2/products/{productId}/global_products.json

    Get all seller’s global products by id

    Parameters

    Name

    productId *required
    string
    (path)

    Description

    8530926

    RESPONSE

    {
      "global_products": {
        "id": 8530926,
        "main_id_shop": 34347,
        "seller_id": 0,
        "shopify_product_id": 7210864246974,
        "product_name": "Demo Global Product",
        "product_type": "Simple",
        "product_description": "This is global product",
        "product_tag": "[\"Global\"]",
        "handle": "demo-global-product",
        "product_meta_info": null,
        "price": "400.00",
        "compare_at_price": "500.00",
        "sales_price": "-1.00",
        "handling_charges": "0.00",
        "transaction_charges": "0.00",
        "track_inventory": 0,
        "quantity": 0,
        "min_purchase_quantity": 1,
        "inventory_policy": 0,
        "active": 1,
        "is_re_approval": 0,
        "has_default_shipping": 0,
        "has_multiple_options": 1,
        "charge_taxes": 1,
        "tax_type": null,
        "hsn": null,
        "cgst": "0.00",
        "sgst": "0.00",
        "gst": "0.00",
        "product_policy": null,
        "id_parent": 0,
        "product_url": "",
        "ref_product_id": "0",
        "custom_fields": null,
        "expiry_date": null,
        "platform": 0,
        "design_id": 0,
        "date_add": "2022-04-14T05:57:31+00:00",
        "date_upd": "2022-04-14T05:57:31+00:00",
        "type": {
          "id": 3,
          "type_name": "global"
        },
        "variants": [
          {
            "id": 28754781,
            "product_id": 8530926,
            "shopify_product_id": 7210864246974,
            "shopify_variant_id": 41368299536574,
            "image_id": 0,
            "sku": "152525655",
            "price": "400.00",
            "sales_price": "-1.00",
            "handling_charges": "0.00",
            "transaction_charges": "0.00",
            "compare_at_price": "500.00",
            "weight": "50000.0000",
            "barcode": "4587987456",
            "track_inventory": 0,
            "quantity": 0,
            "requires_shipping": 1,
            "date_add": "2022-04-14T05:57:31+00:00",
            "date_upd": "2022-04-14T05:57:31+00:00",
            "charge_taxes": 1,
            "dimension": null,
            "inventory_policy": 0,
            "id_parent": 0,
            "seller_variant_details": [],
            "combinations": [
              {
                "id": 53120390,
                "variant_id": 28754781,
                "option_value": "Default Title"
              }
            ],
            "inventory_locations": []
          }
        ],
        "options": [
          {
            "id": 15971362,
            "name": "Title",
            "product_id": 8530926,
            "values": [
              {
                "id": 27535726,
                "option_id": 15971362,
                "value": "Default Title"
              }
            ]
          }
        ],
        "images": [],
        "collections": [],
        "origin_country": null,
        "raise_query": 0
      }
    }

    GET/api/v2/products/{productId}/commission.json

    Get product commission by product id

    Parameters

    Name

    productId *required
    string
    (path)

    Description

    51016

    RESPONSE

    {
      "product_commission": {
        "commission_type": "%",
        "commission": "5.00",
        "active": 1,
        "id_shop": 4302,
        "main_id_shop": 274,
        "sp_id_product": 51016,
        "shopify_product_id": 0
      }
    }

    PUT/api/v2/products/{productId}/commission.json

    Update product commission by product id

    Parameters

    Name

    productId
    json
    (body)







    productsid
    (String)

    Description

    Using this API, you can make changes to the product commission.

    Example value

    {
    “commission_type”: “%”,
    “value”: “0.00”,
    “gp_sales_price”: “0”
    }

    51016

    RESPONSE

    Request:
    {
      "commission_type": "%",
      "value": "10",
      "gp_sales_price": "10"
    }
    
    Response:
    {
      "product_commission": {
        "commission_type": "%",
        "commission": "10.00",
        "active": 1,
        "id_shop": 4302,
        "main_id_shop": 274,
        "sp_id_product": 51016,
        "shopify_product_id": 0
      }
    }

    GET/api/v2/products/{productId}/variants/{variantId}/commission.json

    get variant commission by variant id

    Parameters

    Name

    productId
    string
    (path)

    Variantsid
    string
    (path)

    Description

    27863312

    8313690

    RESPONSE

    {
      "variant_commission": {
        "commission_type": "%",
        "commission": "10.00",
        "active": 1,
        "id_shop": 1042677,
        "main_id_shop": 34347,
        "_sp_id_variant": 27863312,
        "sp_id_product": 8313690,
        "shopify_product_id": 0,
        "shopify_variant_id": 0
      }
    }

    PUT/api/v2/products/{productId}/variants/{variantId}/commission.json

    Update variant commission by variant id

    Parameters

    Name

    Product
    json
    (body)







    productId *
    string
    (path)


    variant Id *
    string
    (path)

    Description

    Using this API, you can make changes to the variant commission.
    Example Value
    {
    “commission_type”: “%”,
    “value”: “0.00”,
    “gp_sales_price”: “0”
    }

    51016




    73885

    RESPONSE

    Request:
    {
      "commission_type": "%",
      "value": "10.00",
      "gp_sales_price": "0"
    }
    Response:
    {
      "variant_commission": {
        "commission_type": "%",
        "commission": "10.00",
        "active": 1,
        "id_shop": 4302,
        "main_id_shop": 274,
        "_sp_id_variant": 73885,
        "sp_id_product": 51016,
        "shopify_product_id": 0,
        "shopify_variant_id": 0
      }
    }

    GET /api/v2/products/moq/{shopifyProductId}.json

    Get minimum order quantity of product variants

    Parameters

    Name

    shopifyVariantIds
    string
    (query)

    shopifyProductId *
    string
    (path)

    Description

    Comma separated variants Ids (like: xxxxxxx14541, xxxxxxx14542)

    RESPONSE

    {
    "moq_status": true,
    "variants": [
    {
    "variant_id": 73925,
    "product_id": 51046,
    "min_order_quantity": 1
    }
    ]
    }

    DELETE /api/v2/products/{productId}/images/{imageId}.json

    Delete image of product by image id

    Parameters

    Name

    productId
    string
    (path)

    ImageId *
    string
    (path)

    Description

    RESPONSE

    {
    "response": "Image has been deleted"
    }

    GET /api/v2/products/features-type.json

    Get product features type like ‘Normal’ or ‘Global’ product

    Parameters
    No parameters

    RESPONSE

    {
    "features_type": [
    {
    "value": 1,
    "label": "Normal Product"
    },
    {
    "value": 2,
    "label": "Digital Product"
    },
    {
    "value": 6,
    "label": "Directory Listing Product"
    },
    {
    "value": 3,
    "label": "Global Product"
    },
    {
    "value": 5,
    "label": "Make an Offer Product"
    },
    {
    "value": 7,
    "label": "Pay What you want Product"
    }
    ]
    }

    GET/api/v2/filter-products-by-tags.json

    Get products by tags and vendor
    Parameter

    Name Description

    tags
    string
    (query)
    Comma separated tags (tags=women,men)
    vendors
    string
    (query)
    Comma separated vendor names (vendors=john,brian)
    collection_handle
    (query)
    collection handle
    page
    integer
    (query)
    Return results of this page.
    Default value : 1
    limit
    integer(query)
    Return up to this many results per page. (maximum: 250)Default value : 50
    sort_by
    string(query)
    Determines the parameter by which the products are sorted in the response. Available parameters are id, price.Default value : id
    sort_order
    string(query)
    Determines the sorting order. 1).asc-> ascending 2).desc-> descendingDefault value : desc

    RESPONSE

     
    {
    "products_count": "4",
    "products": [
    {
    "id": "51092",
    "shopify_product_id": "7805244735725",
    "vendor": "Seller1 Shop",
    "product_name": "Disapproved product",
    "product_tag": [
    "abc",
    " ttttt",
    " wk_booking"
    ],
    "price": "122.00",
    "compare_at_price": "123.00",
    "track_inventory": "0",
    "quantity": "0",
    "image": ""
    },
    {
    "id": "51089",
    "shopify_product_id": "7804898541805",
    "vendor": "Rajan Shop",
    "product_name": "Myproduct",
    "product_tag": [
    "abc"
    ],
    "price": "122.00",
    "compare_at_price": "123.00",
    "track_inventory": "0",
    "quantity": "0",
    "image": ""
    }
    ]
    }

    GET/api/v2/count-products-by-tags.json

    Count products by tags and vendor

    Parameters

    NameDescription
    tagsstring(query)Comma separated tags (tags=women,men)
    vendorsstring(query)Comma separated vendor names (vendors=john,brian)

    RESPONSE

    {
    "tag_count": {
    "xyz": "1",
    "abc": "3",
    "new 1": "0"
    },
    "vendor_count": {
    "seller1": "10",
    "seller4": "20",
    "seller9": "8"
    }
    }

    Need Help regarding Multivendor Product API?

    Drop your query/suggestion at [email protected] or create your ticket at Webkul UV Desk.

    . . .
    Discuss on Helpdesk

    Leave a Comment

    Your email address will not be published. Required fields are marked*


    Be the first to comment.

    Back to Top

    Table of Content