Zid

https://docs.zid.sa
Admin
Zid is an e-commerce platform that provides APIs and tools for partners and developers to build...
Tokens:595,365
Snippets:4,511
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Availability Period Start Example

Source: https://docs.zid.sa/create-a-new-product

Example ISO 8601 formatted string for the start of the product availability period.

```yaml
examples:
  - '2026-08-01T00:00:00Z'
```

--------------------------------

### Availability Period Start Example

Source: https://docs.zid.sa/get-product-by-slug-25772175e0

Example of the availability period start date in ISO 8601 format.

```json
2026-08-01T00:00:00Z
```

--------------------------------

### Bundle Offer OpenAPI Example

Source: https://docs.zid.sa/create-bundle-offer-42028578e0

A complete JSON example of a bundle offer configuration, including start and end dates, conditions for product quantity, and the resulting action for a free product.

```json
example:
  code: bundle_offer
  name:
    en: Buy 2 shirts, get 1 free
    ar: اشترِ قميصين واحصل على واحد مجانًا
  description:
    en: Limited time
    ar: لفترة محدودة
  start_date: '2026-09-01'
  end_date: '2026-09-30'
  conditions_criteria: all
  enabled: true
  auto_adding: true
  conditions:
    - field: products_quantity
      operator: greater_than_or_equal
      value: 2
      applies_to: product
      product_ids:
        - 1f0c8a2e-6b41-4f0a-9d2c-77a1b3e5c904
  actions:
    - field: products
      type: percentage
      value: 100
      products_quantity: 1
      applies_to: product
      product_ids:
        - 3a7d5b19-2c88-4e6f-b1a0-5d9e2f4c7601
```

--------------------------------

### Start Date Property Example

Source: https://docs.zid.sa/create-bundle-offer-42028578e0

Example value for the start_date string property in YYYY-MM-DD format.

```yaml
'2026-09-01'
```

--------------------------------

### Product ID Example

Source: https://docs.zid.sa/create-bundle-offer-42028578e0

Example value for a product UUID.

```yaml
1f0c8a2e-6b41-4f0a-9d2c-77a1b3e5c904
```

--------------------------------

### Product Metadata Example

Source: https://docs.zid.sa/get-product-by-slug-25772175e0

Example of the product metadata object.

```json
{"location_id":"1","childs":[],"parents":[]}
```

--------------------------------

### Get Product Options with Parameters

Source: https://docs.zid.sa/products-1475307m0

Example usage of zid.products.getProductOptions using placeholders for product, attribute, option group, and input field identifiers.

```javascript
await zid.products.get("<product_id>", {
  attributes: {
    "<attribute_id>": "<attribute_value_id>"
  },
  option_fields: {
    "<option_group_id>": ["<option_id>"]
  },
  input_fields: ["<input_field_id>"]
})
```

--------------------------------

### Product IDs Array Example

Source: https://docs.zid.sa/create-bundle-offer-42028578e0

Example array of product UUIDs.

```yaml
- 1f0c8a2e-6b41-4f0a-9d2c-77a1b3e5c904
```

--------------------------------

### Complete Product Template Example

Source: https://docs.zid.sa/bank-discounts-2332488m0

A full example of a product.jinja template showing the placement of the Bank Discounts component relative to other product elements.

```jinja
{% extends "layout.jinja" %}

{% block main_content %}
  <h1>{{ product.name }}</h1>

  {% if product.selected_product.media %}
    <img
      src="{{ product.selected_product.media[0].image.full_size }}"
      alt="{{ product.name }}"
    >
  {% endif %}

  <div class="price">
    {% if product.selected_product.formatted_sale_price %}
      <span>{{ product.selected_product.formatted_sale_price }}</span>
      <del>{{ product.selected_product.formatted_price }}</del>
    {% else %}
      {{ product.selected_product.formatted_price }}
    {% endif %}
  </div>

  {{ product.description | safe }}

  {% include 'vitrin:products/variants_list.jinja' %}

  {% include 'vitrin:shared/bank_discounts.jinja' %}

  {% include 'vitrin:products/payment_widgets.jinja' %}

  <button onclick="zid.cart.addProduct({form_id: 'product-form'})">
    {{ _("Add to Cart") }}
  </button>
{% endblock %}
```

--------------------------------

### Start Date Example

Source: https://docs.zid.sa/view-bundle-offer-38990145e0

Validity start date in YYYY-MM-DD format.

```text
2026-06-01
```

--------------------------------

### Full blog listing page example

Source: https://docs.zid.sa/blogs-jinja-2125764m0

A complete template example showing category filtering and a grid display of blog posts with cover images and snippets.

```jinja
{% extends "layout.jinja" %}

{% block content %}
  <h1>{{ _("Blog") }}</h1>

  {% set active_slug = session.query_params.get('category', '') %}

  {# Category filter pills #}
  {% for category in categories.results %}
    <a href="/blogs?category={{ category.slug }}"
       class="{{ 'is-active' if active_slug == category.slug }}">
      {{ category.name }}
    </a>
  {% endfor %}

  {# Posts grid #}
  {% if blogs.results | length > 0 %}
    {% for blog in blogs.results %}
      <a href="/blogs/{{ blog.slug }}">
        <img src="{{ blog.cover.image.medium }}" alt="{{ blog.title }}">
        <h3>{{ blog.title }}</h3>
        <p>{{ blog.snippet | striptags | truncate(160) }}</p>
      </a>
    {% endfor %}
  {% else %}
    <p>{{ _("No posts found") }}</p>
  {% endif %}
{% endblock %}
```

--------------------------------

### GET https://oauth.zid.sa/oauth/authorize

Source: https://docs.zid.sa/embedded-apps-2168216m0

Initiates the OAuth flow for the merchant to install the embedded app.

```APIDOC
## GET https://oauth.zid.sa/oauth/authorize

### Description
Redirects the merchant to the authorization server to initiate the app installation process. Ensure the `embedded_apps_tokens_write` scope is included.

### Method
GET

### Endpoint
https://oauth.zid.sa/oauth/authorize

### Parameters
#### Query Parameters
- **client_id** (string) - Required - Your application client ID
- **redirect_uri** (string) - Required - Your callback URL
- **response_type** (string) - Required - Must be 'code'
- **scope** (string) - Required - Must include 'embedded_apps_tokens_write'
```

--------------------------------

### Featured Products Section Preview Example

Source: https://docs.zid.sa/schema-files-1702180m0

Example showing the required file naming for a featured-products.jinja section template and its associated preview images.

```text
sections/
├── featured-products.jinja
├── featured-products.png         # Shown when desktop frame is selected
└── featured-products_mobile.png  # Shown when mobile frame is selected
```

--------------------------------

### Get Product by Slug Response

Source: https://docs.zid.sa/get-product-by-slug-25772175e0

Example JSON response returned when successfully fetching a product by slug.

```json
{
    "id": "faa1de09-1e0a-4184-9573-9e639e6d0764",
    "product_class": "grouped_product",
    "sku": "helllo",
    "barcode": "",
    "parent_id": null,
    "name": "Bag",
    "slug": "test-4",
    "price": 1000,
    "short_description": {
        "ar": "وصف مختصر للمنتج",
        "en": "Short product description."
    },
    "sale_price": 850,
    "formatted_price": "SAR 1,000.00",
    "formatted_sale_price": "SAR 850.00",
    "currency": "SAR",
    "currency_symbol": "SAR",
    "attributes": [],
    "categories": [],
    "display_order": 32766,
    "has_options": true,
    "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": "حقيبة",
            "en": "Bag"
        },
        "description": {
            "ar": "وصف المنتج",
            "en": "Product description"
        }
    },
    "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": 1,
        "max_quantity_per_cart": 5,
        "availability_period_start": null,
        "availability_period_end": null,
        "sale_price_period_start": null,
        "sale_price_period_end": null
    },
    "metafields": [],
    "meta": {
        "location_id": "1",
        "childs": [],
        "parents": []
    },
    "related_products_settings": "",
    "related_products_title": {
        "ar": "منتجات ذات صلة",
        "en": "Related products"
    },
    "badge": {
        "body": {
            "ar": "string",
            "en": "string"
        },
        "icon": {
            "code": "string"
        },
        "is_example": true
    },
    "variants": [],
    "description": {
        "ar": "وصف كامل للمنتج",
        "en": "Full product description."
    },
    "custom_user_input_fields": [],
    "custom_option_fields": [],
    "options": [
        {
            "id": "226cb1df-07e6-4a4a-ba55-49134d371ed2",
            "name": "Images",
            "name_i18n": {
                "ar": "صور",
                "en": "Images"
            },
            "slug": "images",
            "choices": [
                "Image 1",
                "Image 2"
            ],
            "choices_metadata": {
                "Image 1": {
                    "id": "948781ef-1117-495c-aea0-f10c8ed7141e",
                    "value": {
                        "ar": "صورة 1",
                        "en": "Image 1"
                    },
                    "type": "icon",
                    "type_value": "https://media.zid.store/attribute-values/images/b59274ca-95c9-47ce-852e-20f5167e4807.jpg"
                },
                "Image 2": {
                    "id": "f7a3da23-d906-4404-afd2-860046e028ff",
                    "value": {
                        "ar": "صورة 2",
                        "en": "Image 2"
                    },
                    "type": "icon",
                    "type_value": "https://media.zid.store/attribute-values/images/a8d34fca-201c-4a72-8b40-8fb11d978491.jpg"
                }
            }
        },
        {
            "id": "eb8f05b2-2928-43b4-b2b2-3144f3aacb24",
            "name": "Colors",
            "name_i18n": {
                "ar": "الألوان",
                "en": "Colors"
            },
            "slug": "colors",
            "choices": [
                "Black",
                "White",
                "Blue"
            ],
            "choices_metadata": {
                "Black": {
                    "id": "a3b083be-1b2d-4ea1-acda-b8c289366787",
                    "value": {
                        "ar": "أسود",
                        "en": "Black"
                    }
                }
            }
        }
    ]
}
```

--------------------------------

### Create Product Request

Source: https://docs.zid.sa/create-product-types-2197235m0

This example demonstrates the POST request and the corresponding JSON payload required to create a product with all available features.

```http
POST /v1/products/
```

```json
{
  "name": {
    "ar": "منتج شامل",
    "en": "Comprehensive Product"
  },
  "description": {
    "ar": "منتج يوضح جميع الميزات المتاحة",
    "en": "Product showcasing all available features"
  },
  "short_description": {
    "ar": "منتج شامل مع جميع الميزات",
    "en": "Comprehensive product with all features"
  },
  "sku": "FULL-001",
  "barcode": "1234567890128",
  "price": 199.99,
  "sale_price": 149.99,
  "cost": 80,
  "quantity": 100,
  "is_infinite": false,
  "is_draft": false,
  "is_published": true,
  "is_taxable": true,
  "requires_shipping": true,
  "weight": {
    "value": 1.5,
    "unit": "kg"
  },
  "keywords": [
    "product",
    "complete",
    "featured"
  ],
  "display_order": 1,
  "seo": {
    "title": {
      "ar": "منتج شامل - متجر متقدم",
      "en": "Comprehensive Product - Advanced Store"
    },
    "description": {
      "ar": "اكتشف منتجنا الشامل بميزات متقدمة",
      "en": "Discover our comprehensive product with advanced features"
    }
  },
  "purchase_restrictions": {
    "min_quantity_per_cart": 1,
    "max_quantity_per_cart": 5,
    "availability_period_start": "2024-01-01T00:00:00Z",
    "availability_period_end": "2024-12-31T23:59:59Z",
    "sale_price_period_start": "2024-01-01T00:00:00Z",
    "sale_price_period_end": "2024-03-31T23:59:59Z"
  },
  "badge": {
    "body": {
      "ar": "خصم {discount_percent}",
      "en": "Discount {discount_percent}"
    }
  }
}
```

--------------------------------

### Blog Post Example Object

Source: https://docs.zid.sa/create-38273359e0

A complete example of a blog post object including localized content, SEO settings, and product relations.

```yaml
examples:
                - title:
                    ar: كيفية تطوير متجرك الإلكتروني
                    en: How to Grow Your Online Store
                  slug: how-to-grow-your-online-store
                  snippet:
                    ar: نصائح عملية تساعدك على تطوير متجرك الإلكتروني.
                    en: Practical tips to help you grow your online store.
                  content:
                    ar: محتوى المقال باللغة العربية.
                    en: Blog post content in English.
                  status: frozen
                  published_at: null
                  scheduled_at: '2026-07-15T10:00:00Z'
                  display_order: 1
                  category_id: 019efe2f-2d93-7bb2-8996-330f8a68ce27
                  tag_ids: null
                  products:
                    - product_id: 8f548fed-d591-48a5-139e-abb58d6dd2b7
                      relation: featured
                      label:
                        ar: المنتج المميز
                        en: Featured product
                      display_order: 1
                  seo:
                    title:
                      ar: دليل تطوير المتجر الإلكتروني
                      en: Online Store Growth Guide
                    description:
                      ar: اكتشف نصائح عملية تساعدك على تطوير متجرك الإلكتروني.
                      en: >-
                        Discover practical tips to help you grow your online
                        store.
                  recommended_posts_mode: automatic
                  recommended_posts_ids:
                    - ceb7a925-f7fc-cf6b-097c-1d6ce23d2d00
                    - 4af486cf-3e2d-bd0a-0318-795dea97ef6b
                  recommended_products_mode: null
                  recommended_products_ids:
                    - 659552bc-54f7-034e-0f0b-e5a292926adb
                    - 7ffeb0ac-d934-e57a-3b6f-3696836eb5a2
```

--------------------------------

### GET /api/v1/scripts Example Response

Source: https://docs.zid.sa/scripts-1758413m0

A sample JSON response from the /api/v1/scripts endpoint, containing external script URLs and an app_scripts_bundle with inline scripts and parameters.

```json
{
  "external_scripts": [
    {
      "id": 101,
      "src": null,
      "url": "https://cdn.example.com/scripts/tracking-abc123.js",
      "status": 2,
      "app_id": 5001,
      "version": 3
    }
  ],
  "app_scripts_bundle": {
    "scripts": {
      "head": [
        "<script type=\"text/javascript\">\n(function () {\n  var s = document.createElement('script');\n  s.async = true;\n  s.src = 'https://widgets.example.com/support.js';\n  document.head.appendChild(s);\n})();\n</script>"
      ],
      "global_head_script": [
        "<script type=\"text/javascript\">\n(function (w,d,s,u) {\n  var js = d.createElement(s);\n  js.async = true;\n  js.src = u;\n  d.head.appendChild(js);\n})(window,document,'script','https://cdn.example-analytics.com/sdk.js');\n</script>"
      ]
    },
    "params": {
      "snapchatPixelId": "...",
      ...
    }
  }
}
```

--------------------------------

### Metafields and Metadata Examples

Source: https://docs.zid.sa/get-a-product-by-id

Examples for metafields list, product metadata, location ID, and child/parent product lists.

```json
[]
```

```json
{"location_id":"1","childs":[],"parents":[]}
```

```json
1
```

```json
[]
```

```json
[]
```

--------------------------------

### cURL Request for Get Payment Status

Source: https://docs.zid.sa/get-payment-status-17286396e0

Example cURL command to retrieve payment status using a specific payment ID and authorization header.

```shell
curl --location 'https://api.paymentprovider.com/payments/b7a1c6f2-9d3e-4e2c-bf1f-05e6a1c8f317' \
--header 'Authorization: Authorization: Basic secret_key'
```

--------------------------------

### products Body Parameter Example

Source: https://docs.zid.sa/update-return-products-27461316e0

Example of the list of products in the reverse order being updated.

```json
[{"id":"550e8400-e29b-41d4-a716-446655440001","received_quantity":1,"not_received_quantity":0,"damaged_quantity":1}]
```

--------------------------------

### Store Identifier Example

Source: https://docs.zid.sa/get-product-by-slug-25772175e0

Example of the store ID.

```json
3
```

--------------------------------

### Product Details Page Example

Source: https://docs.zid.sa/product-jinja-1914519m0

A complete example of a product details page template, demonstrating how to access product properties, display media, handle pricing, and include necessary components.

```jinja
{% extends "layout.jinja" %}

{% block main_content %}
  <h1>{{ product.name }}</h1>

  {% if product.selected_product.media %}
    <img src="{{ product.selected_product.media[0].image.full_size }}" alt="{{ product.name }}">
  {% endif %}

  <div class="price">
    {% if product.selected_product.formatted_sale_price %}
      <span>{{ product.selected_product.formatted_sale_price }}</span>
      <del>{{ product.selected_product.formatted_price }}</del>
    {% else %}
      {{ product.selected_product.formatted_price }}
    {% endif %}
  </div>

  {{ product.description | safe }}

  {% include 'vitrin:products/variants_list.jinja' %}

  {% include 'vitrin:shared/bank_discounts.jinja' %}

  <button onclick="zid.cart.addProduct({form_id: 'product-form'})">
    {{ _("Add to Cart") }}
  </button>
{% endblock %}
```

--------------------------------

### Related Products Settings Example

Source: https://docs.zid.sa/create-a-new-product

Example configuration value for related products settings.

```yaml
examples:
  - ''
```

--------------------------------

### Accept-Language Header Example

Source: https://docs.zid.sa/update-return-products-27461316e0

Example of the language preference header.

```text
en
```

--------------------------------

### Standard Product Example

Source: https://docs.zid.sa/create-a-new-product

A basic example of a standard product payload with essential fields.

```yaml
'2':
                value:
                  name:
                    ar: منتج عادي
                    en: Standard Product
                  description:
                    ar: منتج عادي عام
                    en: A regular general product
                  sku: STANDARD-001
                  barcode: '1234567890128'
                  price: 99.99
                  sale_price: 79.99
                  quantity: 100
                  is_taxable: true
                  requires_shipping: true
                  weight:
                    value: 2.5
                    unit: kg
                  is_draft: false
                  is_published: true
                  keywords:
                    - product
                    - standard
                summary: 'Example 1: Standard Product'
```

--------------------------------

### Location ID Example

Source: https://docs.zid.sa/create-a-new-product

Example identifier for an inventory location.

```yaml
examples:
  - '1'
```

--------------------------------

### Quantity and Date Examples

Source: https://docs.zid.sa/get-a-product-by-id

Examples for quantity limits and ISO 8601 formatted date strings.

```json
1
```

```json
5
```

```json
2026-08-01T00:00:00Z
```

```json
2026-08-31T23:59:59Z
```

```json
2026-08-01T00:00:00Z
```

```json
2026-08-15T23:59:59Z
```

--------------------------------

### products.jinja Template Example

Source: https://docs.zid.sa/products-jinja-1914522m0

This example demonstrates how to extend the layout, conditionally include filters, iterate over product results using a component, and include pagination.

```jinja
{% extends "layout.jinja" %}

{% block main_content %}
  {% if products.filters | length > 0 %}
    {% include 'vitrin:products/filters.jinja' %}
  {% endif %}

  <div class="products">
    {% for product in products.results %}
      {% include 'components/product-card.jinja' %}
    {% endfor %}
  </div>

  {% include 'components/pagination.jinja' %}
{% endblock %}
```

--------------------------------

### Category ID Example

Source: https://docs.zid.sa/create-bundle-offer-42028578e0

Example value for a category ID.

```yaml
'12345'
```

--------------------------------

### Example full blog category object

Source: https://docs.zid.sa/create-38273349e0

A complete example of a blog category object including all required fields and nested SEO metadata.

```yaml
- id: 019efa5c-5608-7a32-a1bb-5ae88530b004
  store_id: 123456
  name:
    ar: الأدلة
    en: Guides
  slug: guides
  description:
    ar: أدلة ونصائح مفيدة
    en: Helpful guides and tips
  icon: book-open
  is_enabled: true
  is_default: false
  display_order: 1
  seo:
    id: 019efa5c-560b-7d23-9eb3-d6d573a5ec8a
    title: {}
    description: null
    created_at: '2026-06-24T16:00:15.883716Z'
    updated_at: '2026-06-24T16:00:15.883755Z'
  created_at: '2026-06-24T16:00:15.880787Z'
  updated_at: '2026-06-24T16:00:15.880818Z'
```

--------------------------------

### Condition Applies To Example

Source: https://docs.zid.sa/create-bundle-offer-42028578e0

Example value for the applies_to property.

```yaml
product
```

--------------------------------

### Store ID Example

Source: https://docs.zid.sa/create-38273359e0

Example value for the store_id property.

```yaml
123456
```

--------------------------------

### vitrin install

Source: https://docs.zid.sa/cli-commands-1390556m0

Installs a specific theme version on a store.

```APIDOC
## vitrin install <store-id> <theme-id> <version-id>

### Description
Install a specific theme version on a store.

### Parameters
- **store-id** (string) - Required - The ID of the store.
- **theme-id** (string) - Required - The ID of the theme.
- **version-id** (string) - Required - The ID of the version.
```

--------------------------------

### Prompt for product retrieval example

Source: https://docs.zid.sa/zid-agent-skill

Use this prompt to find the Zid product endpoint and generate a Python code example.

```text
Find the official Zid endpoint for retrieving products and generate a Python example.
```

--------------------------------

### Activate Installed Theme

Source: https://docs.zid.sa/cli-commands-1390556m0

Activate an installed theme on a store.

```bash
$ vitrin activate <store-id> <installation-id>
```

```bash
$ vitrin activate 123 11111
Activating theme...
✅ Theme activated successfully!
```

--------------------------------

### Product Badge and Variants Examples

Source: https://docs.zid.sa/get-a-product-by-id

Examples for product badge objects and the variants list.

```json
{}
```

```json
[]
```

--------------------------------

### Zid MUI Alert Example

Source: https://docs.zid.sa/zid-mui-1973669m0

Example of a success alert component.

```html
<!-- Success Alert -->
<div class="zid-alert zid-alert--success">
  <div class="zid-alert__icon"><!-- icon svg --></div>
  <div class="zid-alert__content">
    <div class="zid-alert__title">Success</div>
    <div class="zid-alert__message">Your changes have been saved.</div>
  </div>
</div>
```

--------------------------------

### Comprehensive Product Example

Source: https://docs.zid.sa/create-a-new-product

A detailed example of a product payload containing all available features, including SEO, purchase restrictions, and badge information.

```yaml
examples:
              '1':
                value:
                  name:
                    ar: منتج شامل
                    en: Comprehensive Product
                  description:
                    ar: منتج يوضح جميع الميزات المتاحة
                    en: Product showcasing all available features
                  short_description:
                    ar: منتج شامل مع جميع الميزات
                    en: Comprehensive product with all features
                  sku: FULL-001
                  barcode: '1234567890128'
                  price: 199.99
                  sale_price: 149.99
                  cost: 80
                  quantity: 100
                  is_infinite: false
                  is_draft: false
                  is_published: true
                  is_taxable: true
                  requires_shipping: true
                  weight:
                    value: 1.5
                    unit: kg
                  categories:
                    - 1
                    - 2
                    - 3
                  keywords:
                    - product
                    - complete
                    - featured
                  display_order: 1
                  seo:
                    title:
                      ar: منتج شامل - متجر متقدم
                      en: Comprehensive Product - Advanced Store
                    description:
                      ar: اكتشف منتجنا الشامل بميزات متقدمة
                      en: >-
                        Discover our comprehensive product with advanced
                        features
                  purchase_restrictions:
                    min_quantity_per_cart: 1
                    max_quantity_per_cart: 5
                    availability_period_start: '2024-01-01T00:00:00Z'
                    availability_period_end: '2024-12-31T23:59:59Z'
                    sale_price_period_start: '2024-01-01T00:00:00Z'
                    sale_price_period_end: '2024-03-31T23:59:59Z'
                  badge:
                    body:
                      ar: خصم {discount_percent}
                      en: Discount {discount_percent}
                summary: Complete Product with All Features
```

--------------------------------

### Internal Cost Example

Source: https://docs.zid.sa/get-a-product-by-id

Example value for the internal product cost.

```json
500
```

--------------------------------

### Purchase Restrictions Example

Source: https://docs.zid.sa/get-product-by-slug-25772175e0

Example of the purchase restrictions configuration object.

```json
{"min_quantity_per_cart":1,"max_quantity_per_cart":5,"availability_period_start":null,"availability_period_end":null,"sale_price_period_start":null,"sale_price_period_end":null}
```

--------------------------------

### Product Quantity and Period Restrictions Example

Source: https://docs.zid.sa/bulk-update-product

Example configuration for purchase quantity, availability, and sale-price period restrictions.

```yaml
min_quantity_per_cart: 1
max_quantity_per_cart: 5
availability_period_start: null
availability_period_end: null
sale_price_period_start: null
sale_price_period_end: null
```

--------------------------------

### Successful Creation Response Example

Source: https://docs.zid.sa/create-38273359e0

This example shows the JSON structure returned by the API when a blog post is successfully created, including the generated UUID, localized content, and associated product relations.

```json
id: 019efe66-02be-7123-aaed-59b62a960c92
store_id: 3
title:
  ar: title string
  en: title string
slug: string
snippet:
  ar: نص عربي
  en: English text
content:
  ar: نص عربي
  en: English text
status: frozen
published_at: null
scheduled_at: '1955-10-15T11:30:57.161000Z'
display_order: 5111
seo:
  id: 019efe66-02c2-79a1-89f7-5d68ab1c0faa
  title: {}
  description: null
  created_at: '2026-06-25T10:49:18.786540Z'
  updated_at: '2026-06-25T10:49:18.786564Z'
cover: null
category:
  id: 019efe2f-2d93-7bb2-8996-330f8a68ce27
  name:
    ar: نص عربي
    en: English text
  slug: string2
  icon: string
tags: []
products:
  - id: 019efe66-02de-7330-90b1-0c9230f3ef79
    post_id: 019efe66-02be-7123-aaed-59b62a960c92
    product_id: 659552bc-54f7-034e-0f0b-e5a292926adb
    relation: recommended
    label: {}
    display_order: 0
  - id: 019efe66-02de-7330-90b1-0ca59195c612
    post_id: 019efe66-02be-7123-aaed-59b62a960c92
    product_id: 7ffeb0ac-d934-e57a-3b6f-3696836eb5a2
    relation: recommended
    label: {}
    display_order: 1
  - id: 019efe66-02cc-70e0-8d57-a0ec81a29999
    post_id: 019efe66-02be-7123-aaed-59b62a960c92
    product_id: 8f548fed-d591-48a5-139e-abb58d6dd2b7
    relation: featured
    label:
      ar: نص عربي
      en: English text
    display_order: 1
recommended_posts_mode: automatic
recommended_products_mode: disabled
recommended_post_ids:
  - ceb7a925-f7fc-cf6b-097c-1d6ce23d2d00
  - 4af486cf-3e2d-bd0a-0318-795dea97ef6b
recommended_product_ids:
  - 659552bc-54f7-034e-0f0b-e5a292926adb
  - 7ffeb0ac-d934-e57a-3b6f-3696836eb5a2
created_at: '2026-06-25T10:49:18.782959Z'
updated_at: '2026-06-25T10:49:18.782987Z'
```

--------------------------------

### Child Product Identifier Example

Source: https://docs.zid.sa/create-a-new-product

Example UUID for a child product.

```yaml
examples:
  - faa1de09-1e0a-4184-9573-9e639e6d0764
```
Tokens:
Raw