Update an existing product.

This endpoint lets you modify an existing product. You can update various aspects of the product, including:

General Details: Edit core information like title, description, price, and inventory.

Grouped Products: Manage the structure of grouped products (add, remove, or change linked products).

Product Badges: Assign, remove, or update the badge associated with the product.

Creating or modifying variants of a product

To modify or add options (variants) to the product, populate the variants
array in the request body. Each object in the variants array can either
update an existing variant (by specifying its id) or add a new variant (if id is omitted).

Alternatively, you can use the
Add Product Variants
endpoint to add new variants to the product.

🔑Scopes

products.read_write - Products Read & Write

Request

Path Params

product_id

string

required

Example:

107c2ff5-5c70-4749-b9bd-56dc1793013b

Header Params

Accept-Language

enum<string>

optional

Preferred language for the response. Defaults to en if not specified.

Allowed values:

enar

Example:

Access-Token

string

required

An Access Token is a unique string that represents the authorization granted to a client (Partner application) by a user (Merchant or Store Manager) to access their protected resources. It is part of the OAuth 2.0 standard and is used to authenticate API requests on behalf of the user. Access Tokens have a limited lifespan and must be used within their validity period. Once expired, a new Access Token can be obtained using a Refresh Token. Access Tokens should be treated as sensitive information and must be kept secure to prevent unauthorized access to the user's data. If you do not have an Access-Token, but have the older alternative instead, i.e., the X-Manager-Token, then see the instructions here on how to obtain the Access-Token.

Example:

eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=

Authorization

string

required

The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.

Example:

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y

Store-Id

string

optional

Unique identifier of the store.

Example:

37213

Role

string

optional

Role of the user.

Example:

Manager

Body Params application/json

product_class

string

optional

Indicates the type of product. Set to "grouped_product" for grouped products. (Required for Grouped Products)

name

object

optional

Product name in different languages.

string

optional

Example:

منتج جديد

string

optional

Example:

New Product

price

integer

optional

Product price.

Example:

142.44

short_description

null

optional

Short description of the product.

weight

object

optional

Weight of the product.

value

null

optional

Currently set to null, indicating the weight value might need to be provided elsewhere.

unit

string

optional

This field allows you to specify the unit of weight (e.g., "g", "kg", "lb").

Example:

badge

object

optional

A badge is a predefined label or icon a merchant can add to their store.

body

object

optional

icon

object

optional

group_products

array [object {2}]

optional

An array of objects representing the sub-products included in the grouped product. Only required when product_class is set to "grouped_product". Refer to the Update Existing Product documentation for details on the "group_products" fields.

item_id

string

optional

ID of the sub-product within the group.

Example:

143

item_quantity

integer

optional

Number of sub-product included in the grouped product.

Example:

stocks

array [object {3}]

optional

This array provides details about product stock levels. However, the provided fields within stocks seem incomplete.

available_quantity

integer | null

optional

Quantity of the product in stock.

Example:

is_infinite

boolean

optional

Flag to indicate if the product quantity is infinite.

Default:

false

location

string

optional

Details about the storage location (ID and name).

Example

{
  "product_class": "string",
  "name": {
    "ar": "منتج جديد",
    "en": "New Product"
  },
  "price": 142.44,
  "short_description": null,
  "weight": {
    "value": null,
    "unit": "kg"
  },
  "badge": {
    "body": {
      "ar": "منتج مميز",
      "en": "Special Product"
    },
    "icon": {
      "code": "free_shipping"
    }
  },
  "group_products": [
    {
      "item_id": "143",
      "item_quantity": 3
    }
  ],
  "stocks": [
    {
      "available_quantity": 5,
      "is_infinite": false,
      "location": "string"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.zid.sa/v1/products//' \
--header 'Accept-Language;' \
--header 'Access-Token: eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y' \
--header 'Store-Id: 37213' \
--header 'Role: Manager' \
--header 'Content-Type: application/json' \
--data-raw '{
    "product_class": "string",
    "name": {
        "ar": "منتج جديد",
        "en": "New Product"
    },
    "price": 142.44,
    "short_description": null,
    "weight": {
        "value": null,
        "unit": "kg"
    },
    "badge": {
        "body": {
            "ar": "منتج مميز",
            "en": "Special Product"
        },
        "icon": {
            "code": "free_shipping"
        }
    },
    "group_products": [
        {
            "item_id": "143",
            "item_quantity": 3
        }
    ],
    "stocks": [
        {
            "available_quantity": 5,
            "is_infinite": false,
            "location": "string"
        }
    ]
}'

Responses

🟢200Product information is updated

application/json

Body

is_external_product

boolean

optional

This property is used to indicate whether the product is sourced externally.

Default:

false

null

optional

Unique identifier for the product. (Set to null if is_external_product is true)

parent_id

null

optional

Unique identifier for the parent product, if any. This product could be a variant of the parent product. (Set to null if is_external_product is true)

product_class

string

optional

Set to "grouped_product" to indicate it's a group of sub-products.

sku

string

optional

Stock Keeping Unit - unique identifier that allows a product to be tracked for inventory purposes.

barcode

string

optional

This field allows you to specify a barcode associated with the product, if applicable.

name

object

optional

Localized product name in Arabic (ar) and English (en).

string

optional

string

optional

slug

string

optional

SEO friendly URL, usually derived from the product name.

price

integer

optional

Base price of the grouped product (100.0).

short_description

null

optional

This field is optional and can be used to provide a brief description of the product.

sale_price

integer

optional

If the product is on sale, this field specifies the discounted price in the smallest currency unit.

Example:

formatted_price

string

optional

This field contains the base price formatted according to the currency settings.

Example:

10$

formatted_sale_price

string

optional

If applicable, this field holds the formatted discounted price.

Example:

currency

string

optional

currency_symbol

string

optional

Shows the currency type.

attributes

array [object]

optional

meta

object

optional

badge

object

optional

body

object

optional

icon

object

optional

related_products_settings

string

optional

related_products_title

null

optional

variants

array [object]

optional

options

array [object]

optional

cost

integer

optional

is_published

boolean

optional

Indicates if the product is published and visible (true).

waiting_customers_count

null

optional

description

object

optional

custom_user_input_fields

array [object]

optional

custom_option_fields

array [object]

optional

related_products

array [object]

optional

next_product

null

optional

previous_product

null

optional

group_products

array [object {6}]

optional

string

optional

ID of the sub-product within the group.

Example:

143

item

object

optional

origin_product_id

string

optional

item_id

string

optional

item_quantity

integer

optional

in_stock

boolean

optional

stocks

array [object {4}]

optional

This array provides details about product stock.

string

optional

location

object

optional

Details about the storage location (ID and name).

available_quantity

null

optional

Quantity of the product in stock.

is_infinite

boolean

optional

Flag to indicate if the product quantity is infinite.

sold_products_count

null

optional

created_at

string

optional

Date and time the product was created.

updated_at

string

optional

Date and time the product was last updated.

Example

{
  "is_external_product": false,
  "id": null,
  "parent_id": null,
  "product_class": "string",
  "sku": "string",
  "barcode": "string",
  "name": {
    "ar": "string",
    "en": "string"
  },
  "slug": "string",
  "price": 0,
  "short_description": null,
  "sale_price": 50,
  "formatted_price": "10$",
  "formatted_sale_price": "8$",
  "currency": "string",
  "currency_symbol": "string",
  "attributes": [
    {}
  ],
  "categories": [
    {}
  ],
  "display_order": null,
  "has_options": false,
  "has_fields": true,
  "images": [
    {}
  ],
  "is_draft": true,
  "quantity": null,
  "is_infinite": true,
  "html_url": "string",
  "weight": {
    "value": 100,
    "unit": "kg"
  },
  "keywords": [
    {}
  ],
  "requires_shipping": true,
  "is_taxable": false,
  "structure": "string",
  "seo": {
    "title": {
      "ar": "string",
      "en": "string"
    },
    "description": {}
  },
  "rating": {
    "average": 3.9,
    "total_count": 400,
    "1_ratings": {
      "percentage": 0,
      "count": 0
    },
    "2_ratings": {
      "percentage": 0,
      "count": 0
    },
    "3_ratings": {
      "percentage": 0,
      "count": 0
    },
    "4_ratings": {
      "percentage": 0,
      "count": 0
    },
    "5_ratings": {
      "percentage": 0,
      "count": 0
    }
  },
  "store_id": 0,
  "purchase_restrictions": {
    "min_quantity_per_cart": null,
    "max_quantity_per_cart": null,
    "availability_period_start": null,
    "availability_period_end": null,
    "sale_price_period_start": "2024-09-18T21:00:00.000000Z",
    "sale_price_period_end": "2024-09-19T20:59:59.000000Z"
  },
  "metafields": null,
  "meta": {},
  "badge": {
    "body": {
      "ar": "string",
      "en": "string"
    },
    "icon": {
      "code": "string"
    }
  },
  "related_products_settings": "string",
  "related_products_title": null,
  "variants": [
    {}
  ],
  "options": [
    {}
  ],
  "cost": 0,
  "is_published": true,
  "waiting_customers_count": null,
  "description": {},
  "custom_user_input_fields": [
    {}
  ],
  "custom_option_fields": [
    {}
  ],
  "related_products": [
    {}
  ],
  "next_product": null,
  "previous_product": null,
  "group_products": [
    {
      "id": "143",
      "item": {
        "id": "string",
        "product_class": null,
        "sku": "string",
        "barcode": "string",
        "parent_id": null,
        "name": {
          "ar": "string",
          "en": "string"
        },
        "slug": "string",
        "price": 0,
        "short_description": null,
        "sale_price": null,
        "formatted_price": "string",
        "formatted_sale_price": null,
        "currency": "string",
        "currency_symbol": "string",
        "attributes": [
          {}
        ],
        "categories": [
          {}
        ],
        "display_order": null,
        "has_options": true,
        "has_fields": true,
        "images": [
          {}
        ],
        "is_draft": true,
        "quantity": null,
        "is_infinite": true,
        "html_url": "string",
        "weight": {
          "value": null,
          "unit": "string"
        },
        "keywords": [
          {}
        ],
        "requires_shipping": true,
        "is_taxable": true,
        "structure": "string",
        "seo": {
          "title": {
            "ar": "string",
            "en": "string"
          },
          "description": {}
        },
        "rating": {
          "average": 4.1,
          "total_count": 50,
          "1_ratings": {
            "percentage": 0,
            "count": 0
          },
          "2_ratings": {
            "percentage": 0,
            "count": 0
          },
          "3_ratings": {
            "percentage": 0,
            "count": 0
          },
          "4_ratings": {
            "percentage": 0,
            "count": 0
          },
          "5_ratings": {
            "percentage": 0,
            "count": 0
          }
        },
        "store_id": 0,
        "purchase_restrictions": {
          "min_quantity_per_cart": null,
          "max_quantity_per_cart": null,
          "availability_period_start": null,
          "availability_period_end": null
        },
        "metafields": null,
        "meta": null,
        "badge": null,
        "related_products_settings": "string",
        "related_products_title": null,
        "created_at": "string",
        "updated_at": "string",
        "options": [
          {}
        ],
        "group_products": null,
        "stocks": [
          {
            "id": "string",
            "location": {
              "id": "string",
              "name": {
                "ar": "string"
              },
              "type": "string"
            },
            "available_quantity": null,
            "is_infinite": false
          }
        ]
      },
      "origin_product_id": "string",
      "item_id": "string",
      "item_quantity": 0,
      "in_stock": true
    }
  ],
  "stocks": [
    {
      "id": "string",
      "location": {
        "id": "string",
        "name": {
          "ar": "string"
        },
        "type": "string"
      },
      "available_quantity": null,
      "is_infinite": true
    }
  ],
  "sold_products_count": null,
  "created_at": "string",
  "updated_at": "string"
}

Update an existing product.

Creating or modifying variants of a product#

Request

Request samples

Responses

Creating or modifying variants of a product