Create a new product

This endpoint allows you to create a new product, with optional support for grouped products, product badges, and inline variant creation. You can also add variants later using the Add Product Variants endpoint.

Grouped Products: You can now create products that are part of a group. This is useful for managing variations or related items.

Product Badges: Optionally assign a badge to the newly created product. Badges can be used to highlight special offers, new arrivals, or other product attributes.

Creating variants of a product

There are two ways to add product variants:

Inline during product creation – by populating the variants array in the request body (recommended for a small number of variants).

Using the Add Product Variants endpoint – recommended when adding a large number of variants for better control and scalability.

🔑Scopes

products.read_write - Products Read & Write

Request

Header Params

Body Params application/json

Example

{
    "is_draft": false,
    "name": {
        "ar": "منتج جديد",
        "en": "New Product"
    },
    "badge": {
        "value": "string",
        "body": {
            "ar": "string",
            "en": "string"
        }
    },
    "seo": {
        "title": {
            "ar": "string",
            "en": "string"
        },
        "description": {
            "ar": "منتج اختبار",
            "en": "This is a test product"
        }
    },
    "sku": "Z.987654.1234567890",
    "barcode": "string",
    "short_description": {
        "ar": "string",
        "en": "string"
    },
    "description": {
        "ar": "string",
        "en": "string"
    },
    "purchase_restrictions": {
        "min_quantity_per_cart": null,
        "max_quantity_per_cart": null,
        "sale_price_period_start": "2024-09-18T21:00:00.000000",
        "sale_price_period_end": "2024-09-19T20:59:59.000000Z"
    },
    "price": 142.44,
    "sale_price": 0,
    "is_published": true,
    "is_taxable": true,
    "requires_shipping": true,
    "categories": [
        {}
    ],
    "cost": 10,
    "keywords": [
        "[\"apps\",\"social\"]"
    ],
    "slug": "string",
    "weight": {
        "value": 100,
        "unit": "kg"
    },
    "custom_option_fields": [
        {}
    ],
    "custom_user_input_fields": [
        {}
    ],
    "product_class": "string",
    "group_products": [
        {
            "item_id": "string",
            "item_quantity": 3
        }
    ],
    "stocks": [
        {
            "available_quantity": 1,
            "is_infinite": false,
            "location": "string"
        }
    ],
    "": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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 '{
    "is_draft": false,
    "name": {
        "ar": "منتج جديد",
        "en": "New Product"
    },
    "badge": {
        "value": "string",
        "body": {
            "ar": "string",
            "en": "string"
        }
    },
    "seo": {
        "title": {
            "ar": "string",
            "en": "string"
        },
        "description": {
            "ar": "منتج اختبار",
            "en": "This is a test product"
        }
    },
    "sku": "Z.987654.1234567890",
    "barcode": "string",
    "short_description": {
        "ar": "string",
        "en": "string"
    },
    "description": {
        "ar": "string",
        "en": "string"
    },
    "purchase_restrictions": {
        "min_quantity_per_cart": null,
        "max_quantity_per_cart": null,
        "sale_price_period_start": "2024-09-18T21:00:00.000000",
        "sale_price_period_end": "2024-09-19T20:59:59.000000Z"
    },
    "price": 142.44,
    "sale_price": 0,
    "is_published": true,
    "is_taxable": true,
    "requires_shipping": true,
    "categories": [
        {}
    ],
    "cost": 10,
    "keywords": [
        "[\"apps\",\"social\"]"
    ],
    "slug": "string",
    "weight": {
        "value": 100,
        "unit": "kg"
    },
    "custom_option_fields": [
        {}
    ],
    "custom_user_input_fields": [
        {}
    ],
    "product_class": "string",
    "group_products": [
        {
            "item_id": "string",
            "item_quantity": 3
        }
    ],
    "stocks": [
        {
            "available_quantity": 1,
            "is_infinite": false,
            "location": "string"
        }
    ],
    "": "string"
}'

Responses

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

application/json

Body