Create a new product

Request

Header Params

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

X-Manager-Token

string

required

This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token should be included in the header of API requests that require store-related information.

Example:

eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=

Store-Id

number

required

Example:

37213

Accept-Language

enum<string>

optional

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

Allowed values:

enar

Example:

en

Role

enum<string>

required

Role of the user.

Allowed value:

Manager

Example:

Manager

Body Params application/json

is_draft

boolean

optional

Flag to indicate if the product is in draft mode.

Default:

false

name

object

optional

Product name in different languages.

ar

string

optional

Example:

منتج جديد

en

string

optional

Example:

New Product

badge

object

optional

This object manages product badges, including:

value

string

optional

body

object

optional

Localized text for the badge in Arabic (ar) and English (en). This allows you to specify the badge text for both languages.

seo

object

optional

This object allows you to define Search Engine Optimization (SEO) details for your product.

title

object

optional

Localized title for your product in Arabic (ar) and English (en).

description

object

optional

Product description in different languages.

sku

string

required

Stock Keeping Unit associated with the product.

Example:

Z.987654.1234567890

barcode

string

optional

This field allows you to specify the product's barcode.

short_description

object

optional

Localized short descriptions for your product in Arabic (ar) and English (en).

ar

string

optional

en

string

optional

description

object

optional

Description of the product.

ar

string

optional

en

string

optional

purchase_restrictions

object

optional

This object allows you to set purchase restrictions for your product. Currently, both min_quantity_per_cart and max_quantity_per_cart are set to null, indicating these restrictions are not yet implemented.

min_quantity_per_cart

null

optional

max_quantity_per_cart

null

optional

sale_price_period_start

string

optional

This parameter indicates the start date and time for the sale price of the product. It is represented in ISO 8601 format (YYYY-MM-DDTHH:MM
.sssZ) and determines when the discounted sale price becomes effective.

Example:

2024-09-18T21:00:00.000000

sale_price_period_end

string

optional

This parameter represents the end date and time for the sale price of the product. It is also in ISO 8601 format and defines when the discounted sale price ends.

Example:

2024-09-19T20:59:59.000000Z

price

integer

optional

Product price.

Example:

142.44

sale_price

integer

optional

is_published

boolean

optional

Flag to indicate if the product is published.

Default:

true

is_taxable

boolean

optional

Indicates if the product is taxable.

requires_shipping

boolean

optional

Flag to indicate if the product requires shipping.

Default:

true

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.zid.sa/v1/products/' \
--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 'X-Manager-Token: eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=' \
--header 'Store-Id;' \
--header 'Accept-Language;' \
--header 'Role;' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢201The response will include the newly created product data, including the "group_products" field for grouped products.

application/json

Body

is_external_product

boolean

optional

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

Default:

false

id

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).

ar

string

optional

en

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:

50

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:

8$

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

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.

id

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.

id

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"
}

Create a new product

Creating variants of a product#

Request

Request samples

Responses

Creating variants of a product