# Update Product ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/products/{product_id}/: patch: summary: Update Product deprecated: false description: > 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](../reference/merchant-api.yaml/paths/~1products~1{product_id}~1options~1/post) endpoint to add new variants to the product. `products.read_write` - Products Read & Write operationId: update-product tags: - Default module/Apps/Merchant APIs/Products/Managing Products - Products parameters: - name: product_id in: path description: '' required: true example: a497974d-1755-423a-b06c-e0578ba8c318 schema: type: string examples: - 107c2ff5-5c70-4749-b9bd-56dc1793013b - name: Access-Token in: header description: >- 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](docs/Migrate-to-OAUTH-2.0.md) on how to obtain the `Access-Token`. required: true example: '{{Access-Token}}' schema: type: string - name: Authorization in: header description: >- 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. required: true example: '{{Autherization}}' schema: type: string - name: Store-Id in: header description: Unique identifier of the store. required: false example: '{{StoreId}}' schema: type: string - name: Role in: header description: Role of the user. required: false example: Manager schema: type: string - name: Accept-Language in: header description: >- Specifies the preferred language for the response content. Behavior: If the request is authenticated as a Manager (Merchant): - The response always includes both English and Arabic content, regardless of this header. If the request is not authenticated as a Manager: - Accept-Language: all-languages → Response includes both English and Arabic. - Accept-Language: en → Response includes English only. - Accept-Language: ar → Response includes Arabic only. If not provided → Defaults to English (en). required: false example: en schema: type: string enum: - ar - en - all-languages examples: - en x-apidog-enum: - value: ar name: '' description: Response includes Arabic only. - value: en name: '' description: Response includes English only. - value: all-languages name: '' description: ' Response includes both English and Arabic.' requestBody: content: application/json: schema: type: object properties: name: type: object properties: ar: type: string description: Product name in Arabic. en: type: string description: Product name in English. required: - ar - en x-apidog-orders: - ar - en description: >- Localized product name. Keys represent language codes and values represent the product name in that language. x-apidog-ignore-properties: [] description: type: object properties: ar: type: string en: type: string required: - ar - en x-apidog-orders: - ar - en x-apidog-ignore-properties: [] short_description: type: object properties: ar: type: string en: type: string required: - ar - en x-apidog-orders: - ar - en x-apidog-ignore-properties: [] sku: type: string barcode: type: string price: type: number description: >- Base selling price of the product. Value is expressed in the store's default currency. sale_price: type: number cost: type: integer quantity: type: integer is_infinite: type: boolean is_draft: type: boolean is_published: type: boolean is_taxable: type: boolean requires_shipping: type: boolean weight: type: object properties: value: type: number unit: type: string required: - value - unit x-apidog-orders: - value - unit x-apidog-ignore-properties: [] categories: type: array items: type: integer keywords: type: array items: type: string display_order: type: integer seo: type: object properties: title: type: object properties: ar: type: string en: type: string required: - ar - en x-apidog-orders: - ar - en x-apidog-ignore-properties: [] description: type: object properties: ar: type: string en: type: string required: - ar - en x-apidog-orders: - ar - en x-apidog-ignore-properties: [] required: - title - description x-apidog-orders: - title - description x-apidog-ignore-properties: [] purchase_restrictions: type: object properties: min_quantity_per_cart: type: integer max_quantity_per_cart: type: integer availability_period_start: type: string availability_period_end: type: string sale_price_period_start: type: string sale_price_period_end: type: string required: - min_quantity_per_cart - max_quantity_per_cart - availability_period_start - availability_period_end - sale_price_period_start - sale_price_period_end x-apidog-orders: - min_quantity_per_cart - max_quantity_per_cart - availability_period_start - availability_period_end - sale_price_period_start - sale_price_period_end x-apidog-ignore-properties: [] badge: type: object properties: body: type: object properties: ar: type: string en: type: string required: - ar - en x-apidog-orders: - ar - en x-apidog-ignore-properties: [] required: - body x-apidog-orders: - body x-apidog-ignore-properties: [] x-apidog-orders: - name - description - short_description - sku - barcode - price - sale_price - cost - quantity - is_infinite - is_draft - is_published - is_taxable - requires_shipping - weight - categories - keywords - display_order - seo - purchase_restrictions - badge title: Create Product Request (Minimal) description: >- Request payload used to update a product with multilingual name and base price. x-apidog-ignore-properties: [] example: 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} responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProductItemObject' example: id: a497974d-1755-423a-b06c-e0578ba8c318 product_class: null sku: WH-1000XX3 barcode: '' parent_id: null name: ar: منتج en: Product slug: wireless-headphones-7 price: 257 short_description: ar: '' en: '' sale_price: 199 formatted_price: ' SAR 257.00' formatted_sale_price: ' SAR 199.00' currency: SAR currency_symbol: ' SAR ' attributes: [] categories: [] display_order: 32766 has_options: false has_fields: false images: [] videos: [] is_draft: true quantity: 50 is_infinite: false html_url: https://osama.zid.store/products/wireless-headphones-7 weight: value: null unit: kg keywords: [] requires_shipping: true is_taxable: true structure: standalone seo: null 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: null max_quantity_per_cart: null availability_period_start: null availability_period_end: null sale_price_period_start: null sale_price_period_end: null metafields: - id: d2eebc1f-4c4b-4268-bbf2-c463aa3c7a71 name: en: '' ar: تيست slug: تيست-1 data_type: table display_order: 11 value: null - id: 0fdb9855-ba77-4736-beba-e2c1f3b98550 name: en: Calories ar: السعرات الحرارية slug: السعرات الحرارية data_type: number display_order: 10 value: null - id: f620c7fe-240a-4ba4-a206-5db470d3f115 name: en: '' ar: لوحة slug: لوحة data_type: json display_order: 9 value: null - id: 1681dc82-ca68-4147-ad56-b80039ef85de name: en: expiry date ar: تاريخ الإنتهاء slug: تاريخ الإنتهاء data_type: date display_order: 8 value: null - id: a3f4fd3f-6f47-4f78-b82a-cfc89a57b0d0 name: en: tt ar: ttt slug: tttt data_type: file display_order: 7 value: null - id: 8fe0a25f-dd49-44fa-a035-573ab64707fb name: en: eeeuuuu ar: yyyy slug: eee data_type: text display_order: 6 value: null - id: 5a051783-ccdd-4185-ac60-563a93eae477 name: en: '' ar: qeqe slug: qeqe data_type: text display_order: 5 value: null - id: 4a476402-1b24-4c27-9c9f-3abfacde292f name: en: Width ar: '' slug: width of the couch data_type: text display_order: 4 value: null - id: b0ee31c9-b5de-441a-8616-3155b94cff2b name: en: aaaa ar: aaaaa slug: aaa data_type: text display_order: 3 value: null - id: 93c92f9d-b2a3-4ccd-8222-594869ae1e8b name: en: Wight ar: الوزن slug: الوزن data_type: number display_order: 2 value: null - id: e6c621fb-14f0-4974-9ad2-973856699cf4 name: en: Test ar: للاختبار slug: For test data_type: rich_text display_order: 1 value: null meta: null related_products_settings: AUTO_GENERATED related_products_title: ar: '' en: '' badge: null variants: [] cost: null is_published: false description: ar: '' en: '' custom_user_input_fields: [] custom_option_fields: [] options: [] related_products: [] next_product: null previous_product: null group_products: null stocks: - id: 750fef17-de8e-4599-af2c-6e82dc2f09a0 location: id: 59be4f1d-3b59-4b34-ba47-9f7293894b47 name: ar: الدمام en: Dammam type: PHYSICAL full_address: 8RRM+PX Dammam Saudi Arabia available_quantity: 50 is_infinite: false sold_products_count: null created_at: '2026-02-10T18:33:37.084198Z' updated_at: '2026-02-10T18:37:07.756518Z' headers: {} x-apidog-name: OK '401': description: '' content: application/json: schema: type: object description: >- Response returned when the request cannot be authenticated because the required credentials are missing, invalid, or expired. properties: status: type: string description: Indicates the overall status of the API response. examples: - error message: type: object description: >- Contains structured details explaining why the request could not be authenticated. properties: type: type: string description: Indicates the category of the response message. examples: - error code: type: string description: >- A machine-readable code identifying the authentication error. Returns null when no specific code is available. examples: - UNAUTHORIZED nullable: true name: type: string description: >- A short, human-readable title describing the authentication error. Returns null when no title is available. examples: - Unauthorized nullable: true description: type: string description: >- A human-readable explanation of why the request could not be authenticated. Returns null when no detailed explanation is available. examples: - >- Authentication credentials are missing, invalid, or expired. nullable: true required: - type - code - name - description x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] required: - status - message x-apidog-orders: - status - message examples: - status: error message: type: error code: UNAUTHORIZED name: Unauthorized description: >- Authentication credentials are missing, invalid, or expired. x-apidog-ignore-properties: [] examples: '2': summary: Example 1 value: status: error message: type: error code: ERROR_SESSION_MISSING name: Sorry description: Please login first. '3': summary: Example 2 value: status: error message: type: error code: ERROR_SESSION_INVALID name: Sorry description: Login session expired. Please login again. '4': summary: Example 3 value: status: error message: type: error code: ERROR_SESSION_INVALID name: Sorry description: Invalid authentication headers: {} x-apidog-name: Unauthorized '500': description: '' content: application/json: schema: type: object properties: status: type: string description: Status of the error. message: $ref: '#/components/schemas/ResponseEnvelopMessage' required: - status - message x-apidog-orders: - status - message x-apidog-ignore-properties: [] example: status: error message: type: error code: MSG_HIDDEN name: Error description: Internal Server Error headers: {} x-apidog-name: Internal Server error security: [] x-apidog-folder: Default module/Apps/Merchant APIs/Products/Managing Products x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/613905/apis/api-9148568-run components: schemas: ProductItemObject: type: object properties: id: type: string description: Unique product identifier (UUID). examples: - faa1de09-1e0a-4184-9573-9e639e6d0764 nullable: true product_class: type: string description: Product classification type. examples: - grouped_product nullable: true sku: type: string description: Stock Keeping Unit (SKU) of the product. examples: - helllo barcode: type: string description: Barcode associated with the product. examples: - '' parent_id: type: string description: >- Unique identifier of the parent product when this product is a child or variant; otherwise, null. examples: - null nullable: true name: type: object properties: ar: type: string description: Product name in Arabic. examples: - حقيبة en: type: string description: Product name in English. examples: - Bag description: Localized product name. x-apidog-orders: - ar - en examples: - ar: حقيبة en: Bag x-apidog-ignore-properties: [] slug: type: string description: SEO-friendly product slug. examples: - test-4 price: type: number description: Regular product price before applying a sale price. examples: - 1000 short_description: type: object properties: ar: type: string examples: - وصف مختصر للمنتج description: Short product description in Arabic. en: type: string examples: - Short product description. description: Short product description in English. description: Localized short description of the product. x-apidog-orders: - ar - en examples: - ar: وصف مختصر للمنتج en: Short product description. x-apidog-ignore-properties: [] sale_price: type: number description: >- Discounted product price. Returns null when no sale price is configured. examples: - 850 nullable: true formatted_price: type: string description: Formatted product price including currency. examples: - ' SAR 1,000.00' nullable: true formatted_sale_price: type: string description: >- Formatted sale price including the currency symbol. Returns null when no sale price is configured. examples: - SAR 850.00 nullable: true currency: type: string description: Currency code of the product price (ISO 4217). examples: - SAR currency_symbol: type: string description: Currency symbol used for formatting. examples: - ' SAR ' attributes: type: array items: &ref_0 $ref: '#/components/schemas/ProductAttributeObject' description: List of product attributes. examples: - [] categories: type: array items: &ref_1 $ref: '#/components/schemas/ProductCategoryObject' description: Categories assigned to the product. examples: - [] brand: type: object properties: id: &ref_6 type: string format: uuid description: Unique identifier of the brand. examples: - 4f8e78b8-64be-4f58-a79a-31e4e7ba3e80 name: &ref_7 type: string description: Name of the brand. examples: - Nike slug: &ref_8 type: string description: URL-friendly identifier of the brand. examples: - nike logo: &ref_9 type: string description: URL of the brand logo. examples: - https://cdn.example.com/brands/nike.png url: &ref_10 type: string description: Relative storefront URL of the brand page. examples: - /brands/nike x-apidog-orders: - 01M2MTJWS833E80N3GNA56HEGG x-apidog-refs: 01M2MTJWS833E80N3GNA56HEGG: $ref: '#/components/schemas/ProductBrandObject' required: - id - name - slug - logo - url x-apidog-ignore-properties: - id - name - slug - logo - url nullable: true display_order: type: integer description: Display order used for sorting products. examples: - 32766 nullable: true has_options: type: boolean description: Indicates whether the product has selectable options. examples: - false has_fields: type: boolean description: Indicates whether the product has custom input fields. examples: - false images: type: array items: type: object properties: {} x-apidog-orders: [] description: >- Product image object. The available fields depend on the product image schema. examples: - {} x-apidog-ignore-properties: [] description: List of product images. examples: - [] videos: type: array items: type: string description: List of product videos. examples: - [] is_draft: type: boolean description: Indicates whether the product is saved as draft. examples: - false quantity: type: integer description: Available stock quantity. examples: - 19 nullable: true is_infinite: type: boolean description: Indicates unlimited stock availability. examples: - false html_url: type: string description: Public URL of the product page. examples: - https://osama.zid.store/products/test-4 weight: &ref_2 $ref: '#/components/schemas/ProductWeightObject' description: Product weight details, as defined by the referenced weight schema. examples: - {} keywords: type: array items: type: string description: SEO keywords associated with the product. examples: - - bag - strawberries requires_shipping: type: boolean description: Whether the product requires shipping. examples: - true is_taxable: type: boolean description: Whether tax applies to the product. examples: - true structure: type: string description: Product structure type. examples: - standalone seo: type: object properties: title: type: object properties: ar: type: string description: SEO title in Arabic. examples: - حقيبة en: type: string description: SEO title in English. examples: - Bag x-apidog-orders: - ar - en description: Localized SEO title of the product. examples: - ar: حقيبة en: Bag x-apidog-ignore-properties: [] description: type: object properties: ar: type: string description: SEO description in Arabic. examples: - وصف المنتج en: type: string description: SEO description in English. examples: - Product description x-apidog-orders: - ar - en description: Localized SEO description of the product. examples: - ar: وصف المنتج en: Product description x-apidog-ignore-properties: [] x-apidog-orders: - title - description description: SEO metadata for the product. required: - title - description examples: - title: ar: حقيبة en: Bag description: ar: وصف المنتج en: Product description x-apidog-ignore-properties: [] nullable: true rating: type: object properties: average: type: integer description: Average product rating. examples: - 0 total_count: type: integer examples: - 0 description: Total number of submitted product ratings. 1_ratings: type: object properties: percentage: type: integer description: Percentage of all ratings that are 1-star ratings. examples: - 0 count: type: integer description: Number of 1-star ratings. examples: - 0 required: - percentage - count x-apidog-orders: - percentage - count description: Statistics for 1-star ratings. examples: - percentage: 0 count: 0 x-apidog-ignore-properties: [] 2_ratings: type: object properties: percentage: type: integer description: Percentage of all ratings that are 2-star ratings. examples: - 0 count: type: integer description: Number of 2-star ratings. examples: - 0 required: - percentage - count x-apidog-orders: - percentage - count description: Statistics for 2-star ratings. examples: - percentage: 0 count: 0 x-apidog-ignore-properties: [] 3_ratings: type: object properties: percentage: type: integer description: Percentage of all ratings that are 3-star ratings. examples: - 0 count: type: integer description: Number of 3-star ratings. examples: - 0 required: - percentage - count x-apidog-orders: - percentage - count description: Statistics for 3-star ratings. examples: - percentage: 0 count: 0 x-apidog-ignore-properties: [] 4_ratings: type: object properties: percentage: type: integer description: Percentage of all ratings that are 4-star ratings. examples: - 0 count: type: integer description: Number of 4-star ratings. examples: - 0 required: - percentage - count x-apidog-orders: - percentage - count description: Statistics for 4-star ratings. examples: - percentage: 0 count: 0 x-apidog-ignore-properties: [] 5_ratings: type: object properties: percentage: type: integer description: Percentage of all ratings that are 5-star ratings. examples: - 0 count: type: integer description: Number of 5-star ratings. examples: - 0 required: - percentage - count x-apidog-orders: - percentage - count description: Statistics for 5-star ratings. examples: - percentage: 0 count: 0 x-apidog-ignore-properties: [] required: - average - total_count - 1_ratings - 2_ratings - 3_ratings - 4_ratings - 5_ratings description: Product rating statistics. x-apidog-orders: - average - total_count - 1_ratings - 2_ratings - 3_ratings - 4_ratings - 5_ratings examples: - 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 x-apidog-ignore-properties: [] store_id: type: integer description: Store ID owning the product. examples: - 3 purchase_restrictions: type: object properties: min_quantity_per_cart: type: integer description: >- Minimum quantity a customer can add to one cart. Returns null when no minimum is configured. examples: - 1 nullable: true max_quantity_per_cart: type: integer description: >- Maximum quantity a customer can add to one cart. Returns null when no maximum is configured. examples: - 5 nullable: true availability_period_start: type: string description: >- Start date and time of the product availability period in ISO 8601 format. Returns null when unrestricted. examples: - '2026-08-01T00:00:00Z' nullable: true availability_period_end: type: string description: >- End date and time of the product availability period in ISO 8601 format. Returns null when unrestricted. examples: - '2026-08-31T23:59:59Z' nullable: true sale_price_period_start: type: string description: >- Start date and time of the sale-price period in ISO 8601 format. Returns null when no period is configured. examples: - '2026-08-01T00:00:00Z' nullable: true sale_price_period_end: type: string description: >- End date and time of the sale-price period in ISO 8601 format. Returns null when no period is configured. examples: - '2026-08-15T23:59:59Z' nullable: true required: - min_quantity_per_cart - max_quantity_per_cart - availability_period_start - availability_period_end - sale_price_period_start - sale_price_period_end x-apidog-orders: - min_quantity_per_cart - max_quantity_per_cart - availability_period_start - availability_period_end - sale_price_period_start - sale_price_period_end description: >- Purchase quantity, availability, and sale-price period restrictions configured for the product. examples: - 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 x-apidog-ignore-properties: [] metafields: type: array items: &ref_3 $ref: '#/components/schemas/ProductMetaFieldObject' description: List of custom metafields associated with the product. examples: - [] meta: type: object properties: location_id: type: string description: >- Identifier of the inventory location associated with the product. examples: - '1' childs: type: array items: type: string description: Child product identifier. examples: - faa1de09-1e0a-4184-9573-9e639e6d0764 description: List of child product identifiers. examples: - [] parents: type: array items: type: string description: Parent product identifier. examples: - faa1de09-1e0a-4184-9573-9e639e6d0764 description: List of parent product identifiers. examples: - [] x-apidog-orders: - location_id - childs - parents description: >- Additional product metadata, including location and product hierarchy information. examples: - location_id: '1' childs: [] parents: [] x-apidog-ignore-properties: [] nullable: true related_products_settings: type: string description: >- Configuration value controlling how related products are selected or displayed. examples: - '' related_products_title: type: object properties: ar: type: string description: Related-products section title in Arabic. examples: - منتجات ذات صلة en: type: string description: Related-products section title in English. examples: - Related products required: - ar - en x-apidog-orders: - ar - en description: Localized title displayed for the related-products section. examples: - ar: منتجات ذات صلة en: Related products x-apidog-ignore-properties: [] badge: &ref_4 $ref: '#/components/schemas/ProductBadgeObject' description: Product badge details, as defined by the referenced badge schema. examples: - {} variants: type: array items: $ref: '#/components/schemas/ProductVariantObject' description: List of product variants. examples: - [] cost: type: number description: >- Internal cost of the product. Returns null when no cost is configured. examples: - 500 nullable: true is_published: type: boolean description: Indicates whether the product is published and visible to customers. examples: - true waiting_customers_count: type: integer description: >- Number of customers waiting to be notified when the product becomes available. Returns null when unavailable. examples: - 0 nullable: true description: type: object properties: ar: type: string description: Full product description in Arabic. examples: - وصف كامل للمنتج en: type: string description: Full product description in English. examples: - Full product description. x-apidog-orders: - ar - en description: Localized full description of the product. examples: - ar: وصف كامل للمنتج en: Full product description. x-apidog-ignore-properties: [] custom_user_input_fields: type: array items: type: string description: Custom user-input field identifier or value. examples: - engraving_text description: >- List of custom input fields that customers can complete for the product. examples: - [] custom_option_fields: type: array items: type: string description: Custom option field identifier or value. examples: - gift_wrap description: List of custom option fields configured for the product. examples: - [] options: type: array description: >- List of configurable product options and their available choices. Each option can include display metadata for rendering choices as text, color swatches, or images. items: type: object properties: id: type: string format: uuid description: Unique identifier of the product option. examples: - eb8f05b2-2928-43b4-b2b2-3144f3aacb24 name: type: string description: Display name of the product option in the requested language. examples: - Colors name_i18n: type: object description: Localized names of the product option. properties: ar: type: string description: Arabic name of the product option. examples: - الألوان en: type: string description: English name of the product option. examples: - Colors x-apidog-orders: - ar - en examples: - ar: الألوان en: Colors x-apidog-ignore-properties: [] slug: type: string description: URL-friendly identifier of the product option. examples: - colors choices: type: array description: >- List of available values for the product option. Each value can be used as a key in choices_metadata. items: type: string description: Display value of an available product choice. examples: - Black examples: - - Black - White - Blue choices_metadata: type: object description: >- Display metadata for each value listed in choices. Each property name corresponds exactly to a value in the choices array. additionalProperties: type: object properties: id: type: string format: uuid description: Unique identifier of the attribute value. examples: - a3b083be-1b2d-4ea1-acda-b8c289366787 value: type: object description: Localized labels of the attribute value. properties: ar: type: string description: Arabic label of the attribute value. examples: - أسود en: type: string description: English label of the attribute value. examples: - Black x-apidog-orders: - ar - en examples: - ar: أسود en: Black x-apidog-ignore-properties: [] type: type: string enum: - default - color - icon description: >- Presentation type of the choice: default displays text, color displays a color swatch, and icon displays an image. examples: - color type_value: type: string description: >- Presentation value associated with type. Returns null for default, a hexadecimal color code for color, or an absolute image URL for icon. examples: - null - '#000000' - >- https://media.zid.store/attribute-values/images/b59274ca-95c9-47ce-852e-20f5167e4807.jpg nullable: true required: - id - value - type - type_value x-apidog-orders: - id - value - type - type_value x-apidog-ignore-properties: [] examples: - Black: id: a3b083be-1b2d-4ea1-acda-b8c289366787 value: ar: أسود en: Black type: color type_value: '#000000' White: id: d5458526-9a61-4387-a5cf-7e3363b1b274 value: ar: أبيض en: White type: default type_value: null Pattern: id: 948781ef-1117-495c-aea0-f10c8ed7141e value: ar: نمط en: Pattern type: icon type_value: >- https://media.zid.store/attribute-values/images/b59274ca-95c9-47ce-852e-20f5167e4807.jpg x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] x-apidog-orders: - id - name - name_i18n - slug - choices - choices_metadata required: - id - name - name_i18n - slug - choices - choices_metadata x-apidog-ignore-properties: [] examples: - - 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 type: color type_value: '#000000' White: id: d5458526-9a61-4387-a5cf-7e3363b1b274 value: ar: أبيض en: White type: default type_value: null Blue: id: 7c6c59a6-fcc6-4e2c-a5ca-c2d567218771 value: ar: أزرق en: Blue type: color type_value: '#0000FF' related_products: type: array items: type: string description: Related product identifier. examples: - faa1de09-1e0a-4184-9573-9e639e6d0764 description: List of identifiers for products related to this product. examples: - [] next_product: type: string description: >- Identifier of the next product in the current ordering context; otherwise, null. examples: - null nullable: true previous_product: type: string description: >- Identifier of the previous product in the current ordering context; otherwise, null. examples: - null nullable: true group_products: type: string description: >- Grouped-product data or identifier associated with this product; otherwise, null. examples: - null nullable: true stocks: type: array items: &ref_5 $ref: '#/components/schemas/ProductStockObject' description: Stock records for the product across inventory locations. examples: - [] sold_products_count: type: integer description: >- Total number of units sold for the product. Returns null when unavailable. examples: - 0 nullable: true created_at: type: string description: Product creation timestamp (ISO 8601). examples: - '2025-10-28T08:21:10.679886Z' updated_at: type: string description: Last update timestamp (ISO 8601). examples: - '2025-11-18T14:24:07.432413Z' required: - id - product_class - sku - barcode - parent_id - name - slug - price - short_description - sale_price - formatted_price - formatted_sale_price - currency - currency_symbol - attributes - categories - display_order - has_options - has_fields - images - videos - is_draft - quantity - is_infinite - html_url - weight - keywords - requires_shipping - is_taxable - structure - seo - rating - store_id - purchase_restrictions - metafields - meta - related_products_settings - related_products_title - badge - cost - is_published - group_products - stocks - sold_products_count - created_at - updated_at title: ProductItemObject description: >- Represents a detailed product object including pricing, media, inventory, SEO, ratings, metafields, grouped products, variants, and option choice display metadata. x-apidog-orders: - id - product_class - sku - barcode - parent_id - name - slug - price - short_description - sale_price - formatted_price - formatted_sale_price - currency - currency_symbol - attributes - categories - brand - display_order - has_options - has_fields - images - videos - is_draft - quantity - is_infinite - html_url - weight - keywords - requires_shipping - is_taxable - structure - seo - rating - store_id - purchase_restrictions - metafields - meta - related_products_settings - related_products_title - badge - variants - cost - is_published - waiting_customers_count - description - custom_user_input_fields - custom_option_fields - options - related_products - next_product - previous_product - group_products - stocks - sold_products_count - created_at - updated_at x-apidog-refs: {} x-apidog-ignore-properties: [] x-apidog-folder: '' ProductStockObject: type: object properties: id: type: string location: type: object properties: id: type: string name: type: object properties: ar: type: string en: type: string x-apidog-orders: - ar - en x-apidog-ignore-properties: [] type: type: string full_address: type: string required: - id - name - type - full_address x-apidog-orders: - id - name - type - full_address x-apidog-ignore-properties: [] available_quantity: type: integer nullable: true is_infinite: type: boolean x-apidog-orders: - id - location - available_quantity - is_infinite required: - id - location - available_quantity - is_infinite x-apidog-ignore-properties: [] x-apidog-folder: '' ProductVariantObject: type: object properties: id: type: string product_class: type: string nullable: true sku: type: string barcode: type: string parent_id: type: string nullable: true name: type: object properties: ar: type: string en: type: string x-apidog-orders: - ar - en x-apidog-ignore-properties: [] slug: type: string price: type: number short_description: type: object properties: ar: type: string en: type: string x-apidog-orders: - ar - en x-apidog-ignore-properties: [] sale_price: type: number nullable: true formatted_price: type: string formatted_sale_price: type: string nullable: true currency: type: string currency_symbol: type: string attributes: type: array items: *ref_0 categories: type: array items: *ref_1 display_order: type: integer nullable: true has_options: type: boolean has_fields: type: boolean images: type: array items: type: string videos: type: array items: type: string is_draft: type: boolean quantity: type: integer is_infinite: type: boolean html_url: type: string weight: anyOf: - *ref_2 - type: 'null' keywords: type: array items: type: string requires_shipping: type: boolean is_taxable: type: boolean structure: type: string seo: type: string nullable: true rating: type: object properties: average: type: number total_count: type: integer 1_ratings: type: object properties: percentage: type: integer count: type: integer x-apidog-orders: - percentage - count required: - percentage - count x-apidog-ignore-properties: [] 2_ratings: type: object properties: percentage: type: integer count: type: integer x-apidog-orders: - percentage - count required: - percentage - count x-apidog-ignore-properties: [] 3_ratings: type: object properties: percentage: type: integer count: type: integer x-apidog-orders: - percentage - count required: - percentage - count x-apidog-ignore-properties: [] 4_ratings: type: object properties: percentage: type: integer count: type: integer x-apidog-orders: - percentage - count required: - percentage - count x-apidog-ignore-properties: [] 5_ratings: type: object properties: percentage: type: integer count: type: integer x-apidog-orders: - percentage - count required: - percentage - count x-apidog-ignore-properties: [] x-apidog-orders: - average - total_count - 1_ratings - 2_ratings - 3_ratings - 4_ratings - 5_ratings required: - average - total_count - 1_ratings - 2_ratings - 3_ratings - 4_ratings - 5_ratings x-apidog-ignore-properties: [] store_id: type: integer purchase_restrictions: type: object properties: min_quantity_per_cart: type: integer nullable: true max_quantity_per_cart: type: integer nullable: true availability_period_start: type: integer nullable: true availability_period_end: type: integer nullable: true sale_price_period_start: type: integer nullable: true sale_price_period_end: type: integer nullable: true x-apidog-orders: - min_quantity_per_cart - max_quantity_per_cart - availability_period_start - availability_period_end - sale_price_period_start - sale_price_period_end required: - min_quantity_per_cart - max_quantity_per_cart - availability_period_start - availability_period_end - sale_price_period_start - sale_price_period_end x-apidog-ignore-properties: [] metafields: type: array items: *ref_3 meta: type: array items: type: string nullable: true related_products_settings: type: string related_products_title: type: object properties: ar: type: string en: type: string x-apidog-orders: - ar - en x-apidog-ignore-properties: [] badge: anyOf: - *ref_4 - type: 'null' cost: type: number nullable: true is_published: type: boolean waiting_customers_count: type: integer nullable: true group_products: type: array items: type: string nullable: true stocks: type: array items: *ref_5 sold_products_count: type: integer nullable: true created_at: type: string updated_at: type: string x-apidog-orders: - id - product_class - sku - barcode - parent_id - name - slug - price - short_description - sale_price - formatted_price - formatted_sale_price - currency - currency_symbol - attributes - categories - display_order - has_options - has_fields - images - videos - is_draft - quantity - is_infinite - html_url - weight - keywords - requires_shipping - is_taxable - structure - seo - rating - store_id - purchase_restrictions - metafields - meta - related_products_settings - related_products_title - badge - cost - is_published - waiting_customers_count - group_products - stocks - sold_products_count - created_at - updated_at required: - id - product_class - sku - barcode - parent_id - name - slug - price - short_description - sale_price - formatted_price - formatted_sale_price - currency - currency_symbol - attributes - categories - display_order - has_options - has_fields - images - videos - is_draft - quantity - is_infinite - html_url - weight - keywords - requires_shipping - is_taxable - structure - seo - rating - store_id - purchase_restrictions - metafields - meta - related_products_settings - related_products_title - badge - cost - is_published - group_products - stocks - sold_products_count - created_at - updated_at x-apidog-ignore-properties: [] x-apidog-folder: '' ProductBadgeObject: type: object properties: body: type: object properties: ar: type: string en: type: string x-apidog-orders: - ar - en x-apidog-ignore-properties: [] icon: type: object properties: code: type: string x-apidog-orders: - code x-apidog-ignore-properties: [] nullable: true is_example: type: boolean x-apidog-orders: - body - icon - is_example x-apidog-ignore-properties: [] nullable: true x-apidog-folder: '' ProductMetaFieldObject: type: object properties: id: type: string name: type: object properties: en: type: string ar: type: string x-apidog-orders: - en - ar x-apidog-ignore-properties: [] slug: type: string data_type: type: string display_order: type: integer value: type: string required: - id - name - slug - data_type - display_order - value x-apidog-orders: - id - name - slug - data_type - display_order - value x-apidog-ignore-properties: [] x-apidog-folder: '' ProductWeightObject: type: object properties: value: type: number nullable: true unit: type: string description: Weight unit. examples: - kg required: - value - unit description: Product weight details. x-apidog-orders: - value - unit x-apidog-ignore-properties: [] x-apidog-folder: '' ProductBrandObject: type: object description: >- Brand assigned to the product. Returns null when no brand is associated with the product. properties: id: *ref_6 name: *ref_7 slug: *ref_8 logo: *ref_9 url: *ref_10 required: - id - name - slug - logo - url x-apidog-orders: - id - name - slug - logo - url examples: - id: 4f8e78b8-64be-4f58-a79a-31e4e7ba3e80 name: Nike slug: nike logo: https://cdn.example.com/brands/nike.png url: /brands/nike x-apidog-ignore-properties: [] nullable: true x-apidog-folder: '' ProductCategoryObject: type: object properties: id: type: string name: type: object properties: ar: type: string en: type: string x-apidog-orders: - ar - en x-apidog-ignore-properties: [] slug: type: string description: type: object properties: ar: type: string en: type: string x-apidog-orders: - ar - en x-apidog-ignore-properties: [] cover_image: type: string nullable: true image: type: string nullable: true display_order: type: integer nullable: true meta: type: object properties: childs: type: array items: type: integer parents: type: array items: type: integer x-apidog-orders: - childs - parents required: - childs - parents x-apidog-ignore-properties: [] nullable: true x-apidog-orders: - id - name - slug - description - cover_image - image - display_order - meta required: - id - name - slug - description - cover_image - image - display_order - meta x-apidog-ignore-properties: [] x-apidog-folder: '' ProductAttributeObject: type: object properties: id: type: string slug: type: string name: type: string value: type: object properties: ar: type: string en: type: string x-apidog-orders: - ar - en x-apidog-ignore-properties: [] type: type: string type_value: type: object properties: ar: type: string en: type: string x-apidog-orders: - ar - en x-apidog-ignore-properties: [] product_id: type: string attribute_image_id: type: string nullable: true display_order: type: integer nullable: true attribute_id: type: string attribute_display_order: type: integer nullable: true use_as_filter: type: boolean x-apidog-orders: - id - slug - name - value - type - type_value - product_id - attribute_image_id - display_order - attribute_id - attribute_display_order - use_as_filter required: - id - slug - name - value - type - type_value - product_id - attribute_image_id - display_order - attribute_id - attribute_display_order - use_as_filter x-apidog-ignore-properties: [] x-apidog-folder: '' ResponseEnvelopMessage: type: object properties: type: type: string description: Type of response message returned by the API. examples: - success code: type: string description: Response code returned by the API, if available. examples: - MSG_POPUP_OK nullable: true name: type: string description: Name or title of the response message, if available. examples: - Coupons nullable: true description: type: string description: Detailed description of the response message, if available. examples: - Coupons created successfully nullable: true required: - type - code - name - description description: Additional response metadata. x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: {} servers: - url: https://api.zid.sa/ description: Prod Env security: [] ```