Update Product

put https://{shopdomain}.myshoplaza.com/openapi/2022-01/products/{product_id}

🔒
Requires write_product access scope. For more access scope

📘
Important Note: When updating the same product, the updateProduct API is more performant than updateVariant. If there are multiple updates for the same product (e.g., updating variant prices), it is strongly recommended to use updateProduct to avoid potential locking issues. This ensures better performance and reduces delays.

The Update Product API allows developers to update product details by using its unique domain prefix (shopdomain) and providing various configurable fields. This endpoint supports modifying specific fields such as product title, description, variants and images. It is particularly useful for managing product catalog updates and maintaining accurate product information.This API is especially useful for:

Updating product metadata like title, description, and SEO fields through its unique identifier (product_id).
Managing product variants, options, and inventory details.

Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all updates are applied to the correct store.

Public Request Parameters

Parameter Name	Type	Required	Parameter Location	Parameter Value	Description
Access-Token	`String`	Yes	Header	Bx-_5aV eXNwl-4AB98s5xLV yg0fNzGf MuTpqtlBA	Used to authenticate API requests. Obtain an access token from the Access Token Guide. Pass it in the `Authorization` header for every request.
Content-Type	`String`	Yes	Header	`application` `/json`	Indicates the media type of the request body. It tells the server how to parse the request and the client how to interpret the response. For more details, visit Content-Type.

Public Response Parameters

Parameter Name	Type	Mandatory	Parameter Location	Example Value	Description
error	String	No	Response Body	`{ "error": "store is not active" }`	Indicates an error encountered during the process. This field typically appears when the Access Token is missing or invalid. Example: `{ "error": "store is not active" }`.
errors	Array	No	Response Body	`{ "errors"["No Context"] }`	A list of errors that occurred during the request processing. Example: `{ "errors": [ "No Context" ] }`.
Request-Id	String	Yes	Header	Bx-_5aV eXNwl-4AB98s5xLV yg0fNzGf MuTpqtlBA	A unique identifier for each request. It helps in identifying and debugging specific requests.

Error and Errors Clarification:

Added explanation that the error and errors fields are currently dependent on the API implementation, with plans for future unification.

Request Parameters

Path Parameters

Parameter	Type	Required	Example	Description
`product_id`	`string`	Yes	`9fb9f3c6-2300-42c1-8593-d9008d7cfc09`	The unique identifier for the product.

Body Parameters

Parameter	Type	Required	Example	Description
product.title	`string`	No	`"New Product Title"`	The title of the product.
product.brief	`string`	No	`"Short description"`	A brief description of the product.
product.description	`string`	No	`"Detailed product description"`	A detailed description of the product in HTML format.
product.published	`boolean`	No	`true`	Indicates whether the product is published.
product.requires_shipping	`boolean`	No	`true`	Specifies if the product requires shipping.
product.taxable	`boolean`	No	`false`	Indicates whether the product is taxable.
product.tags	`string`	No	`"tag1,tag2,tag3"`	A comma-separated list of tags for the product. Useful for categorization.
product.vendor	`string`	No	`"Vendor Name"`	The vendor of the product, limited to 100 characters It is applicable in scenarios like product creation, supply chain management and categorization.
product.vendor_url	`string`	No	`"https://vendor-website.com"`	The URL of the vendor.
product.note	`string`	No	`"Product note"`	Additional notes about the product.
product.seo_title	`string`	No	`"SEO Title"`	The SEO title for the product.
product.seo_description	`string`	No	`"SEO Description"`	The SEO description for the product.
product.seo_keywords	`string`	No	`"keyword1,keyword2"`	SEO keywords for the product, separated by commas.
product.handle	`string`	No	`"product-handle"`	The unique handle for the product.
product.inventory_tracking	`boolean`	No	`true`	Specifies if inventory tracking is enabled for the product.
product.inventory_policy	`string`	No	`"deny"`	Inventory policy: `continue`, `deny`, `auto_unpublished`, required while `inventory_tracking` is true
product.spu	`string`	No	`"SPU12345"`	The Standard Product Unit (SPU) identifier for the product.
product.fake_sales	`integer`	No	`100`	The number of fake sales displayed for the product.
product.display_fake_sales	`boolean`	No	`true`	Whether to display fake sales for the product.
product.need_variant_image	`boolean`	No	`true`	The need_variant_image field is automatically set to true if any variant has an image; otherwise, it is set to false.
product.has_only_default_variant	`boolean`	No	`false`	Specifies if the product has only a default variant.
product.options	`array`	No	Array of Options Object
product.options.name	`string`	Yes	`"Size"`	The name of the option (e.g., Size).
product.options.values	`array`	Yes	`["S", "M", "L"]`	The values for the option (e.g., S, M).
product.images	`array`	No	Array of Image Object
product.images.id	`string`	No	`"image-id"`	The unique identifier for the image.
product.images.src	`string`	No	`"https://image-url.com/image.jpg"`	The source URL for the image.
product.images.width	`integer`	No	`800`	The width of the image.
product.images.height	`integer`	No	`600`	The height of the image.
product.images.alt	`string`	No	`"Image alt text"`	Alternative text for the image.
product.variants	`array`	No	Array of Variants Object
product.variants.id	`string`	Yes	`"variant-id"`	The unique identifier for the variant.
product.variants.option1	`string`	No	`"S"`	The first option value for the variant.
product.variants.option2	`string`	No	`"Blue"`	The second option value for the variant.
product.variants.option3	`string`	No	`"T"`	The third option value for the variant.
product.variants.price	`float`	No	`10.00`	The price of the variant.
product.variants.sku	`string`	No	`"SKU123"`	The SKU for the variant.
product.variants.inventory_quantity	`integer`	No	`100`	The inventory quantity available for the variant.
product.variants.extend	`array`	No	Array of Extend Object
product.variants.extend.length	`number`	No	`10.0`	The length of the variant in the specified dimension unit.
product.variants.extend.width	`number`	No	`5.0`	The width of the variant in the specified dimension unit.
product.variants.extend.height	`number`	No	`15.0`	The height of the variant in the specified dimension unit.
product.variants.extend.dimension_unit	`string`	No	`in`	Unit of measurement for dimensions (e.g., cm, in).
product.variants.extend.origin _country_code	`string`	No	`AG`	Country of origin code of the product
product.variants.extend.hs_Code	`string`	No	`62114390`	HS codes are the international standard for commodity classification, and Shoplazza can automatically generate HS codes based on commodity information.
product.variants.wholesale_price	`array`	No	Array of Wholesale Price
product.variants.wholesale_price. price	`string`	Yes	`"8.99"`	The wholesale price for the variant.
product.variants.wholesale_price. min_quantity	`integer`	Yes	`10`	Minimum quantity for the price.
no_entity	`boolean`	No	`false`	If `true`, the API will not return product entity details in the response.

Response Explanation

Successful Response

Field	Type	Example	Description
product	object		The main product object.
product.brief	string	"shirt"	A brief description of the product.
product.created_at	string	"2024-04-17T02:15:18Z"	The timestamp of product creation.
product.description	string	" Desc "	The detailed description of the product.
product.display_fake_sales	boolean	true	Indicates if fake sales should be displayed.
product.fake_sales	integer	10	The number of fake sales displayed.
product.handle	string	"shirt"	The handle of the product.
product.has_only_default_variant	boolean	false	Indicates if the product has only a default variant.
product.id	string	"a1a88be0-a1d4-47e4-a2f2-ba6e131cf447"	The unique identifier of the product.
product.image	object	Image Object	The main image of the product.
product.image.src	string	"//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg"	URL of the product image.
product.image.width	integer	174	The width of the product image.
product.image.height	integer	180	The height of the product image.
product.image.path	string	"ccf0794c594bad32a320eea0d6bfe40c.jpeg"	The path of the product image.
product.image.alt	string	""	The alternate text for the product image.
product.images	array of objects	array of image objects	A list of additional product images.
product.images[].id	string	"8ef098c5-5a08-44b4-b5fb-89214bb507dc"	The unique identifier of the image.
product.images[].product_id	string	"a1a88be0-a1d4-47e4-a2f2-ba6e131cf447"	The associated product ID.
product.images[].position	integer	1	The position of the image in the gallery.
product.images[].src	string	"//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg"	The URL of the image.
product.images[].width	integer	174	The width of the image.
product.images[].height	integer	180	The height of the image.
product.images[].alt	string	""	The alternate text for the image.
product.images[].created_at	string	"2024-04-17T02:15:18Z"	The creation timestamp of the image.
product.images[].updated_at	string	"2024-04-17T02:15:35Z"	The last update timestamp of the image.
product.inventory_policy	string	"continue"	Required when inventory_tracking is set to true. The following options are available: - `continue`: Continue selling when out of stock - `deny`: Stop selling when out of stock - `auto_unpublished`: Set as draft when out of stock
product.inventory_quantity	integer	72	The inventory quantity of the product.
product.inventory_tracking	boolean	true	`true` if inventory is tracked, `false` if not. It relates to the logic of whether a product or its variants can be purchased.
product.mixed_wholesale	boolean	false	Indicates if the product supports mixed wholesale.
product.need_variant_image	boolean	true	Indicates if a variant image is required.
product.note	string	""	Any notes about the product.
product.options	array	Array of Options Objects	The product options, such as size and color.
product.options[].id	string	"a4fc1abf-86fb-4e45-b774-9ff3b3f8ef90"	The unique identifier of the option.
product.options[].product_id	string	"a1a88be0-a1d4-47e4-a2f2-ba6e131cf447"	The associated product ID.
product.options[].position	integer	1	The position of the option.
product.options[].name	string	"size"	The name of the option.
product.options[].values	array of strings	["S", "L"]	The values available for the option.
product.published	boolean	false	Indicates if the product is published.
product.published_at	string	"1970-01-01T00:00:00Z"	The timestamp when the product was published.
product.requires_shipping	boolean	true	Indicates if the product requires shipping.
product.seo_description	string	"Desc"	The SEO description for the product.
product.seo_keywords	string	""	The SEO keywords for the product.
product.seo_title	string	"shirt"	The SEO title for the product.
product.spu	string	"T-M"	The SPU (Standard Product Unit) for the product.
product.tags	string	"s1-s2"	A comma-separated list of tags for the product. Useful for categorization.
product.taxable	boolean	true	Indicates if the product is taxable.
product.title	string	"shirt"	The title of the product.
product.updated_at	string	"2024-04-17T02:15:35Z"	The timestamp of the last product update.
product.variants	array	array of Variant Objects	A list of product variants.
product.variants[].id	string	"88e68830-4ef5-4125-bf7d-aef8047176b2"	The unique identifier of the variant.
product.variants[].product_id	string	"a1a88be0-a1d4-47e4-a2f2-ba6e131cf447"	The associated product ID.
product.variants[].image_id	string	"8ef098c5-5a08-44b4-b5fb-89214bb507dc"	The ID of the associated image.
product.variants[].created_at	string	"2024-04-17T02:15:18Z"	The creation timestamp of the variant.
product.variants[].updated_at	string	"2024-04-17T02:15:35Z"	The last update timestamp of the variant.
product.variants[].title	string	"S-blue-T"	The title of the variant.
product.variants[].option1	string	"S"	The value of the first option.
product.variants[].option2	string	"blue"	The value of the second option.
product.variants[].option3	string	"T"	The value of the third option.
product.variants[].position	integer	1	The position of the variant in the list.
product.variants[].compare_at_price	string	"12.10"	The compare-at price of the variant.
product.variants[].price	string	"10.10"	The price of the variant.
product.variants[].sku	string	"T-M-S-blue-T-A001004"	The SKU of the variant.
product.variants[].barcode	string	"6929000212340"	The barcode of the variant.
product.variants[].note	string	"node"	Any notes about the variant.
product.variants[].inventory_quantity	integer	10	The inventory quantity of the variant.
product.variants[].weight	string	"1.10"	The weight of the variant.
product.variants[].weight_unit	string	"kg"	The weight unit of the variant.
product.variants[].cost_price	string	"1.10"	The cost price of the variant.
product.variants[].wholesale_price	array of objects	Array of Wholesale Price	The wholesale price details of the variant
product.variants.wholesale_price. price	string	"10"	Minimum quantity for the price.
product.variants.wholesale_price. min_quantity	integer	0	If `true`, the API will not return product entity details in the response.

Error Response

Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.

Field	Type	Example	Description
`errors`	Array	`["Context"]`	A list of errors encountered during the request processing.

Field	Type	Example	Description
`error`	Array	`"store is not active"`	Indicates an error encountered during the process.

Request Examples

curl --request PUT \
     --url https://jinhanbaob2330i.myshoplaza.com/openapi/2022-01/products/a1a88be0-a1d4-47e4-a2f2-ba6e131cf447 \
     --header 'accept: application/json' \
     --header 'access-token: bXJMS9Ge193sBsGtwWNPHv3AD3eNZthICKOpUTs9vL4' \
     --header 'content-type: application/json' \
     --data '
{
  "no_entity": false,
  "product": {
    "title": "test"
  }
}
'

Success Response Example

{
  "product": {
    "brief": "shirt",
    "created_at": "2024-04-17T02:15:18Z",
    "description": "<p>Desc</p>",
    "display_fake_sales": true,
    "fake_sales": 10,
    "handle": "shirt",
    "has_only_default_variant": false,
    "id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
    "image": {
      "src": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
      "width": 174,
      "height": 180,
      "path": "ccf0794c594bad32a320eea0d6bfe40c.jpeg",
      "alt": ""
    },
    "images": [
      {
        "id": "8ef098c5-5a08-44b4-b5fb-89214bb507dc",
        "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
        "position": 1,
        "src": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
        "width": 174,
        "height": 180,
        "alt": "",
        "created_at": "2024-04-17T02:15:18Z",
        "updated_at": "2024-04-17T02:15:35Z"
      }
    ],
    "inventory_policy": "continue",
    "inventory_quantity": 72,
    "inventory_tracking": true,
    "mixed_wholesale": false,
    "need_variant_image": true,
    "note": "",
    "options": [
      {
        "id": "a4fc1abf-86fb-4e45-b774-9ff3b3f8ef90",
        "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
        "position": 1,
        "name": "size",
        "values": [
          "S",
          "L"
        ]
      },
      {
        "id": "d6a27294-e070-4c00-988d-8d54122638a7",
        "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
        "position": 2,
        "name": "color",
        "values": [
          "blue",
          "red"
        ]
      },
      {
        "id": "449e7329-a355-43b3-b17e-cfd499599086",
        "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
        "position": 3,
        "name": "type",
        "values": [
          "T",
          "S"
        ]
      }
    ],
    "published": false,
    "published_at": "1970-01-01T00:00:00Z",
    "requires_shipping": true,
    "seo_description": "Desc",
    "seo_keywords": "",
    "seo_title": "shirt",
    "spu": "T-M",
    "tags": "s1-s2",
    "taxable": true,
    "title": "shirt",
    "updated_at": "2024-04-17T02:15:35Z",
    "variants": [
      {
        "id": "88e68830-4ef5-4125-bf7d-aef8047176b2",
        "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
        "image_id": "8ef098c5-5a08-44b4-b5fb-89214bb507dc",
        "created_at": "2024-04-17T02:15:18Z",
        "updated_at": "2024-04-17T02:15:35Z",
        "title": "S-blue-T",
        "option1": "S",
        "option2": "blue",
        "option3": "T",
        "image": {
          "src": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
          "width": 174,
          "height": 180,
          "path": "ccf0794c594bad32a320eea0d6bfe40c.jpeg",
          "alt": ""
        },
        "position": 1,
        "compare_at_price": "12.10",
        "price": "10.10",
        "sku": "T-M-S-blue-T-A001004",
        "barcode": "6929000212340",
        "note": "node",
        "inventory_quantity": 10,
        "weight": "1.10",
        "weight_unit": "kg",
        "cost_price": "1.10",
        "wholesale_price": [
          {
            "price": "10.10",
            "min_quantity": 1
          }
        ],
        "extend": {
          "length": 10,
          "width": 10,
          "height": 10,
          "dimension_unit": "in",
          "origin_country_code": "AG",
          "hs_code": "62114390"
        }
      },
      {
        "id": "deab5c4b-0ceb-498c-b2b6-d742321f3d20",
        "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
        "image_id": "8ef098c5-5a08-44b4-b5fb-89214bb507dc",
        "created_at": "2024-04-17T02:15:18Z",
        "updated_at": "2024-04-17T02:15:35Z",
        "title": "S-blue-S",
        "option1": "S",
        "option2": "blue",
        "option3": "S",
        "image": {
          "src": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
          "width": 174,
          "height": 180,
          "path": "ccf0794c594bad32a320eea0d6bfe40c.jpeg",
          "alt": ""
        },
        "position": 2,
        "compare_at_price": "12.10",
        "price": "10.10",
        "sku": "T-M-S-blue-S-A001005",
        "barcode": "6929000212340",
        "note": "node",
        "inventory_quantity": 2,
        "weight": "1.10",
        "weight_unit": "kg",
        "cost_price": "1.10",
        "wholesale_price": [
          {
            "price": "10.10",
            "min_quantity": 1
          }
        ],
        "extend": {
          "length": 10,
          "width": 10,
          "height": 10,
          "dimension_unit": "in",
          "origin_country_code": "AO",
          "hs_code": "62114390"
        }
      },
      {
        "id": "41a37521-ae26-4259-9771-22ef0221788c",
        "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
        "image_id": "8ef098c5-5a08-44b4-b5fb-89214bb507dc",
        "created_at": "2024-04-17T02:15:18Z",
        "updated_at": "2024-04-17T02:15:35Z",
        "title": "S-red-T",
        "option1": "S",
        "option2": "red",
        "option3": "T",
        "image": {
          "src": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
          "width": 174,
          "height": 180,
          "path": "ccf0794c594bad32a320eea0d6bfe40c.jpeg",
          "alt": ""
        },
        "position": 3,
        "compare_at_price": "12.10",
        "price": "10.10",
        "sku": "T-M-S-red-T-A001006",
        "barcode": "6929000212340",
        "note": "node",
        "inventory_quantity": 10,
        "weight": "1.10",
        "weight_unit": "kg",
        "cost_price": "1.10",
        "wholesale_price": [
          {
            "price": "10.10",
            "min_quantity": 1
          }
        ],
        "extend": {
          "length": 10,
          "width": 10,
          "height": 10,
          "dimension_unit": "in",
          "origin_country_code": "AI",
          "hs_code": "62114390"
        }
      },
      {
        "id": "97cbf601-7dbb-4ab4-86f2-c9b8d632494e",
        "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
        "image_id": "8ef098c5-5a08-44b4-b5fb-89214bb507dc",
        "created_at": "2024-04-17T02:15:18Z",
        "updated_at": "2024-04-17T02:15:35Z",
        "title": "S-red-S",
        "option1": "S",
        "option2": "red",
        "option3": "S",
        "image": {
          "src": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
          "width": 174,
          "height": 180,
          "path": "ccf0794c594bad32a320eea0d6bfe40c.jpeg",
          "alt": ""
        },
        "position": 4,
        "compare_at_price": "12.10",
        "price": "10.10",
        "sku": "T-M-S-red-S-A001007",
        "barcode": "6929000212340",
        "note": "node",
        "inventory_quantity": 10,
        "weight": "1.10",
        "weight_unit": "kg",
        "cost_price": "1.10",
        "wholesale_price": [
          {
            "price": "10.10",
            "min_quantity": 1
          }
        ],
        "extend": {
          "length": 10,
          "width": 10,
          "height": 10,
          "dimension_unit": "in",
          "origin_country_code": "AI",
          "hs_code": "62114390"
        }
      },
      {
        "id": "a7175820-36b3-4fc6-9baf-51e3035242ba",
        "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
        "image_id": "8ef098c5-5a08-44b4-b5fb-89214bb507dc",
        "created_at": "2024-04-17T02:15:18Z",
        "updated_at": "2024-04-17T02:15:35Z",
        "title": "L-blue-T",
        "option1": "L",
        "option2": "blue",
        "option3": "T",
        "image": {
          "src": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
          "width": 174,
          "height": 180,
          "path": "ccf0794c594bad32a320eea0d6bfe40c.jpeg",
          "alt": ""
        },
        "position": 5,
        "compare_at_price": "12.10",
        "price": "10.10",
        "sku": "T-M-L-blue-T-A001008",
        "barcode": "6929000212340",
        "note": "node",
        "inventory_quantity": 10,
        "weight": "1.10",
        "weight_unit": "kg",
        "cost_price": "1.10",
        "wholesale_price": [
          {
            "price": "10.10",
            "min_quantity": 1
          }
        ],
        "extend": {
          "length": 10,
          "width": 10,
          "height": 10,
          "dimension_unit": "in",
          "origin_country_code": "AO",
          "hs_code": "62114390"
        }
      },
      {
        "id": "e9a785a4-739b-45e6-93bb-d056d706c295",
        "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
        "image_id": "8ef098c5-5a08-44b4-b5fb-89214bb507dc",
        "created_at": "2024-04-17T02:15:18Z",
        "updated_at": "2024-04-17T02:15:35Z",
        "title": "L-blue-S",
        "option1": "L",
        "option2": "blue",
        "option3": "S",
        "image": {
          "src": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
          "width": 174,
          "height": 180,
          "path": "ccf0794c594bad32a320eea0d6bfe40c.jpeg",
          "alt": ""
        },
        "position": 6,
        "compare_at_price": "12.10",
        "price": "10.10",
        "sku": "T-M-L-blue-S-A001009",
        "barcode": "6929000212340",
        "note": "node",
        "inventory_quantity": 10,
        "weight": "1.10",
        "weight_unit": "kg",
        "cost_price": "1.10",
        "wholesale_price": [
          {
            "price": "10.10",
            "min_quantity": 1
          }
        ],
        "extend": {
          "length": 10,
          "width": 10,
          "height": 10,
          "dimension_unit": "in",
          "origin_country_code": "AS",
          "hs_code": "62114390"
        }
      },
      {
        "id": "14665246-d39e-46d6-a87a-23ad54db8477",
        "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
        "image_id": "8ef098c5-5a08-44b4-b5fb-89214bb507dc",
        "created_at": "2024-04-17T02:15:18Z",
        "updated_at": "2024-04-17T02:15:35Z",
        "title": "L-red-T",
        "option1": "L",
        "option2": "red",
        "option3": "T",
        "image": {
          "src": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
          "width": 174,
          "height": 180,
          "path": "ccf0794c594bad32a320eea0d6bfe40c.jpeg",
          "alt": ""
        },
        "position": 7,
        "compare_at_price": "12.10",
        "price": "10.10",
        "sku": "T-M-L-red-T-A001010",
        "barcode": "6929000212340",
        "note": "node",
        "inventory_quantity": 10,
        "weight": "1.10",
        "weight_unit": "kg",
        "cost_price": "1.10",
        "wholesale_price": [
          {
            "price": "10.10",
            "min_quantity": 1
          }
        ],
        "extend": {
          "length": 10,
          "width": 10,
          "height": 10,
          "dimension_unit": "in",
          "origin_country_code": "AQ",
          "hs_code": "62114390"
        }
      },
      {
        "id": "cbd7a7b0-5dd7-4902-9466-e21bd02688b4",
        "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
        "image_id": "8ef098c5-5a08-44b4-b5fb-89214bb507dc",
        "created_at": "2024-04-17T02:15:18Z",
        "updated_at": "2024-04-17T02:15:35Z",
        "title": "L-red-S",
        "option1": "L",
        "option2": "red",
        "option3": "S",
        "image": {
          "src": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
          "width": 174,
          "height": 180,
          "path": "ccf0794c594bad32a320eea0d6bfe40c.jpeg",
          "alt": ""
        },
        "position": 8,
        "compare_at_price": "12.10",
        "price": "10.10",
        "sku": "T-M-L-red-S-A001011",
        "barcode": "6929000212340",
        "note": "node",
        "inventory_quantity": 10,
        "weight": "1.10",
        "weight_unit": "kg",
        "cost_price": "1.10",
        "wholesale_price": [
          {
            "price": "10.10",
            "min_quantity": 1
          }
        ],
        "extend": {
          "length": 10,
          "width": 10,
          "height": 10,
          "dimension_unit": "in",
          "origin_country_code": "DZ",
          "hs_code": "62114390"
        }
      }
    ],
    "vendor": "shoplazza",
    "vendor_url": "https://shoplazza.com"
  }
}

Error Response Example

{
  "errors": ["Product not found"]
}

{
  "error": "store is not active"
}

Response Explanation

Product Response Fields

Status Code	Message	Possible Reason	Example Response
400	Bad Request	Invalid input format or request structure (e.g., missing required fields or incorrect data types).	`Bad Request`
	Unauthorized	The request is missing valid authentication credentials or the credentials provided are invalid.	`Unauthorized`
404	Product Not Found	The product ID provided in the request does not exist.	`{ "errors": ["Product not found"] }`
422	Failed Validation	One or more fields failed validation checks.	`{ "errors": [ "Variant price must be entered."]}`
	Invalid or empty `id`	missing required `id` or `id` with incorrect `UUID` types	`{ "errors": [ "Id is not an invalid UUID"]}`

Language

Credentials

Header

URL

Click Try It! to start a request and see the response here!

🔒Requires write_product access scope. For more access scope

Public Request Parameters

Public Response Parameters

Request Parameters

Path Parameters

Body Parameters

Response Explanation

Successful Response

Error Response

Request Examples

Success Response Example

Error Response Example

Response Explanation

Product Response Fields

🔒
Requires `write_product` access scope. For more access scope