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
What you can do with Multivendor Product API
Multivendor Product API lets you do the following functions on the products:
- GET /api/v2/products.json
⠀–Get all products of a store - POST /api/v2/products.json
–Create/Add a new product to the store - GET /api/v2/products/count.json
⠀–Get count of all products - GET /api/v2/products/{productId}.json
⠀–Get product by product id - PUT /api/v2/products/{productId}.json
–Update product by product id - DELETE /api/v2/products/{productId}.json
⠀–Delete product by product id - DELETE /api/v2/products/{productId}/variants/{variantId}.json
–Delete product variant by product id & variant id - POST /api/v2/products/{productId}/variants.json
–Create/Add a new variant for a product - GET /api/v2/products/{productId}/collections.json
-Get all collections by product id - GET /api/v2/products/{productId}/images.json
–Get all images by product id - GET /api/v2/products/{productId}/variants.json
-Get all variants by product id - GET /api/v2/products/{productId}/variants/{variantId}.json
-Get variant by product id & variant id - PUT /api/v2/products/{productId}/variants/{variantId}.json
-Update variant by product id & variant id
Product Properties
| id | This is the product ID, a unique human-friendly string for the product. |
| main_id_shop | This is the admin store’s unique ID. |
| seller_id | Vendor ID |
| product_name | This returns the name of the product. |
| product_type | A categorization for the product used for filtering and searching products. |
| product_description | Returns the description of the product. |
| product_tag | A 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. |
| handle | A unique human-friendly string for the product. Automatically generated from the product’s title. |
| product_meta_info | Metafields are extra pieces of data that apps can attach to products. |
| price | The price of the product. |
| compare_at_price | The original price of the item before an adjustment or a sale. |
| sales_price | This returns the sales price. If off the value will be -1. |
| handling_charges | This returns the handling charges of the product. |
| transaction_charges | This returns the transaction charges of the product. |
| track_inventory | Returns if the fulfillment service tracks the number of items in stock for the product variant or not. Valid values: 0: Doesn’t Track1: Track |
| quantity | This returns the product quantity. |
| inventory_policy | Whether 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. |
| active | Value- 0/1. Returns the product status as live or not. |
| sku | A unique identifier for the product variant in the shop. Required in order to connect to a Fulfillment Service. |
| barcode | The barcode, UPC, or ISBN number for the product. |
| has_default_shipping | This returns 0/1, i.e., if product has shipping (1) or not (0). |
| has_multiple_options | Returns 1 if the product has variants. (In case of digital product returns 0) |
| charge_taxes | Whether a tax is charged when the product is sold. Valid values are 0 & 1. |
| tax_type | Returns the tax type. |
| hsn | Return the product HSN value. (Only for GST Feature App) |
| cgst | Return the product CGST value. (Only for GST Feature App) |
| sgst | Return the product SGST value. (Only for GST Feature App) |
| gst | Return the product GST value. (Only for GST Feature App) |
| product_policy | Returns if the product includes policy or not. |
| id_parent | Returns global product ID. |
| product_url | This is for Directory Listing feature of the app. |
| expiry_date | This is for the product expiry feature. |
| design_id | This is for the Artist Product Design feature. |
| date_add | The date and time when the product was created. |
| type | This returns the product type as Normal or Digital. “type”: { “id”: 1, “type_name”: “normal” }, |
Variant Properties
| id | An unsigned 64-bit integer that’s used as a unique identifier for the variant. |
| product_id | This is a unique product ID. |
| shopify_product_id | This is a unique Shopify product ID. |
| shopify_variant_id | This is a unique Shopify variant ID. |
| image_id | This is a unique image ID of the variant’s image. |
| weight | The weight of the product variant in the unit system. |
| track_inventory | Returns if the fulfillment service tracks the number of items in stock for the product variant or not. Valid values: 0: Doesn’t Track1: Track |
| quantity | This returns the variant quantity. |
| date_add | The date and time when the product was created. |
| dimension | This returns the dimensions of the variants added in the store. (json format) |
| inventory_policy | Whether 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_parent | Returns global product ID. |
| combinations | Returns store attributes. “combinations”: [ { “id”: 1000001, “variant_id”: 10001, “option_value”: “Default Title” } |
| inventory_locations | Returns 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
| id | An unsigned 64-bit integer that’s used as a unique identifier for the option. |
| name | The custom properties that a shop owner uses to define product variants. You can define three options for a product: option1, option2, option3. |
| product_id | This is a unique product ID. |
| values | Returns the values like id, option id & value of the option. “values”: [ { “id”: 10001, “option_id”: 100001, “value”: “Default Title” } ] |
Image Properties
| id | The unique numeric identifier for a product’s image. The image must be associated to the same product as the variant. |
| product_id | This is a unique product ID. |
| active | Status of the image that whether it is live or not. |
| position | Returns the position of the image. |
| img_url | Returns the image URL. |
| img_sm | Returns the image URL. |
| img_md | Returns the image URL. |
| img_lg | Returns the image URL. |
| img_alt | Returns the image alt text. |
| process_status | If the image is updated on our S3, it will return processed otherwise in-process. |
Collection Properties
| id | An unsigned 64-bit integer that’s used as a unique identifier for the collection. |
| product_id | This is a unique product ID. |
| shopify_category_id | This is the Shopify’s unique ID for collection. |
| category_name | This returns the name of the collection. |
| handle | A unique human-friendly string for the product. Automatically generated from the collection’s title. |
| level | Returns 1 if the collection has subcategories. Else, returns o. |
| id_parent | If level=1, it returns the ID of the parent category. |
| active | returns 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
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’.
Example:
|
1 |
{"id":"10001", product_name":"White Shirt", "id_shop":"10001", "type":"1"} |
RESPONSE
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
{ "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/count.json
Get the count of all products of a store
Parameters
Name
seller_id
integer
(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:
|
1 |
{"type":"1", "platform":"2"} |
RESPONSE
|
1 2 3 |
{ "count": 1001 } |
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
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
{ "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
Parameters
Name
Products
json
(body)
Description
Create/Add a new product to the store
Example Value
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
{ "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
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
{ "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
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
|
1 2 3 4 5 6 7 8 9 10 11 |
{ "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
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
{ "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
|
1 |
[] |
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
|
1 |
[] |
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
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
{ "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" } ] } |
An unsigned 64-bit integer that’s used as a unique identifier for the product.
RESPONSE
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
{ "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
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
{ "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
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
{ "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
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
{ "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
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
{ "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
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
{ "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
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
{ "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 } } ] } } |
Need Help regarding Multivendor Product API?
Drop your query/suggestion at support@webkul.com or create your ticket at Webkul UV Desk.
Be the first to comment.