Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

Update Product

PATCH

https://api.zid.sa/v1/products/{product_id}/

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

Header Params

Body Params application/json

Example

{
  "name": {
    "ar": "منتج",
    "en": "Product"
  },
  "price": 142.99
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.zid.sa/v1/products/05d39420-f1ba-475a-b298-d67c5bfa017c/' \
--header 'Accept-Language: en' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Authorization: {{Autherization}}' \
--header 'Store-Id: 3' \
--header 'Role: Manager' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": {
    "ar": "منتج",
    "en": "Product"
  },
  "price": 142.99
}'

Responses

🟢200Product information is updated

application/json

Body

Example

{
    "id": "05d39420-f1ba-475a-b298-d67c5bfa017c",
    "product_class": null,
    "sku": "Z.17694339194606497",
    "barcode": "",
    "parent_id": null,
    "name": {
        "ar": "منتج",
        "en": "Product"
    },
    "slug": "testq",
    "price": 142.99,
    "short_description": {
        "ar": "",
        "en": ""
    },
    "sale_price": null,
    "formatted_price": " SAR 142.99",
    "formatted_sale_price": null,
    "currency": "SAR",
    "currency_symbol": " SAR ",
    "attributes": [],
    "categories": [],
    "display_order": 32766,
    "has_options": true,
    "has_fields": false,
    "images": [],
    "videos": [],
    "is_draft": false,
    "quantity": 1190,
    "is_infinite": false,
    "html_url": "https://osama.zid.store/products/testq",
    "weight": {
        "value": null,
        "unit": "kg"
    },
    "keywords": [],
    "requires_shipping": true,
    "is_taxable": true,
    "structure": "parent",
    "rating": {
        "average": 0,
        "total_count": 0
    },
    "store_id": 3,
    "variants": [
        {}
    ],
    "options": [
        {
            "id": "string",
            "name": "string",
            "slug": "string",
            "choices": [
                "string"
            ]
        }
    ],
    "stocks": [
        {
            "id": "string",
            "available_quantity": 0,
            "is_infinite": true
        }
    ],
    "created_at": "2026-01-26T13:25:19.467362Z",
    "updated_at": "2026-01-28T10:24:52.927254Z"
}

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-01-30 20:55:20

Retrieve Product Settings

Bulk Update Products

Update Product

Creating or modifying variants of a product#

Request

Request Code Samples

Responses

Creating or modifying variants of a product