Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.
- 🗂️ Overview
- 🚀 Start Here
- Create your First App
- Responses
- Rate Limiting
- Authorization
- StoreFront Events
- Merchant APIs
- Orders
- Reverse Orders
- Abandoned Carts
- Products
- Inventories
- Shipping
- Marketing
- Gift Cards
- Coupons
- Bundle Offers
- Loyalty Program
- Calculate Loyalty Points for Order
- Retrieve Store Loyalty Status
- Activate Loyalty Program
- Retrieve Loyalty Program Status
- Set Points Expiration Rules
- Update Cashback Rule
- Update Cashback Rule Status
- Create Points Redemption Method
- Update Points Redemption Method
- Delete Points Redemption Method
- Update Redemption Method Status
- Retrieve Customer Loyalty Summary
- List Loyalty Data
- List Customer Points History
- Retrieve Manager Loyalty Info Page
- Update Loyalty Info Page
- Adjust Customer Points
- Customers
- Store Settings
- Countries and Cities
- Orders
- Webhooks
- App Management
Create Product
POST
https://api.zid.sa/v1/products/
You can also add variants later using the Add Product Variants endpoint.
Features#
There are two ways to add product variants:
1.
2.
Important Notes#
To assign a product to one or more categories, use the following endpoints after creation:
🔑Scopes
products.read_write - Products Read & WriteRequest
Header Params
Body Params application/json
Example
{
"name": "Wireless Headphones",
"price": 257,
"sale_price": 199,
"sku": "WH-1000XX٢",
"is_draft": true,
"is_infinite": false,
"quantity": 50,
"requires_shipping": true,
"is_taxable": true
}
Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.zid.sa/v1/products/' \
--header 'Authorization: {{Autherization}}' \
--header 'X-Manager-Token: {{Access-Token}}' \
--header 'Store-Id: {{StoreId}}' \
--header 'Accept-Language: en' \
--header 'Role: Manager' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Wireless Headphones",
"price": 257,
"sale_price": 199,
"sku": "WH-1000XX٢",
"is_draft": true,
"is_infinite": false,
"quantity": 50,
"requires_shipping": true,
"is_taxable": true
}'Responses
🟢201OK
application/json
Body
Example
{
"id": "faa1de09-1e0a-4184-9573-9e639e6d0764",
"product_class": "grouped_product",
"sku": "helllo",
"barcode": "",
"parent_id": "string",
"name": {
"ar": "test",
"en": ""
},
"slug": "test-4",
"price": 0,
"short_description": {
"ar": "",
"en": ""
},
"sale_price": 0,
"formatted_price": " SAR 1,000.00",
"formatted_sale_price": "string",
"currency": "SAR",
"currency_symbol": " SAR ",
"attributes": [],
"categories": [],
"display_order": 32766,
"has_options": false,
"has_fields": false,
"images": [
{}
],
"videos": [],
"is_draft": false,
"quantity": 19,
"is_infinite": false,
"html_url": "https://osama.zid.store/products/test-4",
"weight": {
"value": 0,
"unit": "kg"
},
"keywords": [
"bag",
"strawberries"
],
"requires_shipping": true,
"is_taxable": true,
"structure": "standalone",
"seo": {
"title": {
"ar": "string",
"en": "string"
},
"description": {
"ar": "string",
"en": "string"
}
},
"rating": {
"average": 0,
"total_count": 0,
"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": 3,
"purchase_restrictions": {
"min_quantity_per_cart": 0,
"max_quantity_per_cart": 0,
"availability_period_start": 0,
"availability_period_end": 0,
"sale_price_period_start": 0,
"sale_price_period_end": 0
},
"metafields": [
{
"id": "string",
"name": {
"en": "string",
"ar": "string"
},
"slug": "string",
"data_type": "string",
"display_order": 0,
"value": "string"
}
],
"meta": {
"location_id": "string",
"childs": [
"string"
],
"parents": [
"string"
]
},
"related_products_settings": "string",
"related_products_title": {
"ar": "string",
"en": "string"
},
"badge": {
"body": {
"ar": "string",
"en": "string"
},
"icon": {
"code": "string"
}
},
"variants": [
{
"id": "string",
"product_class": "string",
"sku": "string",
"barcode": "string",
"parent_id": "string",
"name": {
"ar": "string",
"en": "string"
},
"slug": "string",
"price": 0,
"short_description": {
"ar": "string",
"en": "string"
},
"sale_price": 0,
"formatted_price": "string",
"formatted_sale_price": "string",
"currency": "string",
"currency_symbol": "string",
"attributes": [
{
"id": "string",
"slug": "string",
"name": "string",
"value": {
"ar": "string",
"en": "string"
},
"type": "string",
"type_value": {
"ar": "string",
"en": "string"
},
"product_id": "string",
"attribute_image_id": "string",
"display_order": 0,
"attribute_id": "string",
"attribute_display_order": 0,
"use_as_filter": true
}
],
"categories": [
{
"id": "string",
"name": {
"ar": "string",
"en": "string"
},
"slug": "string",
"description": {
"ar": "string",
"en": "string"
},
"cover_image": "string",
"image": "string",
"display_order": 0,
"meta": {
"childs": [
"string"
],
"parents": [
"string"
]
}
}
],
"display_order": 0,
"has_options": true,
"has_fields": true,
"images": [
"string"
],
"videos": [
"string"
],
"is_draft": true,
"quantity": 0,
"is_infinite": true,
"html_url": "string",
"weight": {
"value": 0,
"unit": "kg"
},
"keywords": [
"string"
],
"requires_shipping": true,
"is_taxable": true,
"structure": "string",
"seo": "string",
"rating": {
"average": 0,
"total_count": 0,
"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": 0,
"max_quantity_per_cart": 0,
"availability_period_start": 0,
"availability_period_end": 0,
"sale_price_period_start": 0,
"sale_price_period_end": 0
},
"metafields": [
{
"id": "string",
"name": {
"en": "string",
"ar": "string"
},
"slug": "string",
"data_type": "string",
"display_order": 0,
"value": "string"
}
],
"meta": [
"string"
],
"related_products_settings": "string",
"related_products_title": {
"ar": "string",
"en": "string"
},
"badge": {
"body": {
"ar": "string",
"en": "string"
},
"icon": {
"code": "string"
}
},
"cost": 0,
"is_published": true,
"waiting_customers_count": 0,
"group_products": [
"string"
],
"stocks": [
{
"id": "string",
"location": {
"id": "string",
"name": {
"ar": "string",
"en": "string"
},
"type": "string",
"full_address": "string"
},
"available_quantity": 0,
"is_infinite": true
}
],
"sold_products_count": 0,
"created_at": "string",
"updated_at": "string"
}
],
"cost": 0,
"is_published": true,
"waiting_customers_count": 0,
"description": {
"ar": "string",
"en": "string"
},
"custom_user_input_fields": [
"string"
],
"custom_option_fields": [
"string"
],
"options": [
{
"id": "string",
"name": "string",
"slug": "string",
"choices": [
"string"
]
}
],
"related_products": [
"string"
],
"next_product": "string",
"previous_product": "string",
"group_products": "string",
"stocks": [
{
"id": "string",
"location": {
"id": "string",
"name": {
"ar": "string",
"en": "string"
},
"type": "string",
"full_address": "string"
},
"available_quantity": 0,
"is_infinite": true
}
],
"sold_products_count": 0,
"created_at": "2025-10-28T08:21:10.679886Z",
"updated_at": "2025-11-18T14:24:07.432413Z"
}🟠401Unauthorized
🟠400Bad Request
🔴500Internal Server error
Modified at 2026-02-08 13:58:13