Zid Docs
Apps
ThemesPayments
Apps
ThemesPayments
Help Center
Slack
  1. Managing Products
  • 🗂️ Overview
  • 🚀 Start Here
  • Create your First App
  • Responses
  • Rate Limiting
  • Authorization
  • Embedded Apps
  • StoreFront Events
  • Zid MUI
  • Zid SDKs
  • Our custom MCP server
  • Merchant APIs
    • Account
      • Me
        • Me
        • Profile
      • Store
        • Store
        • Branding
        • Localization
        • Social
        • Operations
        • Business
        • Upload Logo Image
        • Delete Logo Image
        • Upload Icon Image
        • Delete Icon Image
        • Upload Cover Image
        • Delete Cover Image
    • Orders
      • Validate Order Request
      • Create Order
      • Change Order Status
      • Add Order Comment
      • View Order
      • List Orders
      • List Custom Order Statuses
      • List Order Credit Notes
    • Reverse Orders
      • Create Reverse Orders
      • Create Reverse Orders Waybill
      • Add Reverse Order Reasons
      • List Reverse Reasons
      • Calculate Reverse Totals
      • Create refund for reverse order
      • Upload bank transfer receipt
      • Update return products
      • Order Details – View for Return
    • Abandoned Carts
      • List Carts
      • View Cart
    • Products
      • Managing Products
        • Create Product Types
        • Create Product
          POST
        • List Products
          GET
        • View Product
          GET
        • List Product Settings
          GET
        • Update Product
          PATCH
        • Bulk Update Products
          PATCH
        • Delete Product
          DELETE
      • Digital Vouchers
        • List Vouchers
        • Order Vouchers
        • Create Voucher
        • Import Vouchers
        • Export Vouchers
        • Update Voucher
        • Remove Voucher
      • Product Categories
        • List Categories
        • View Category
        • Create Category
        • Create Subcategory
        • Update Category
        • Assign Product to Category
        • Bulk Assign Products to Category
        • Publish Category
        • Detach Category from All Products
        • Remove Product from Category
      • Product Badge
        • List Badges
      • Product Attributes
        • List Attributes
        • View Attribute
        • Create Attribute
        • Update Attribute
        • Delete Attribute
      • Product Attribute Presets
        • List Presets
        • Create Preset
        • Update Preset
        • Delete Preset
      • Product Variants
        • Create Variants
        • Create Custom Option
        • Update Custom Option
        • Delete Custom Option Field
        • Create Custom Input Field
        • Update Custom Input Field
        • Delete Custom Input Field
      • Product Sorting
        • Set Manual Product Order
        • Reset Manual Product Order
      • Product Images
        • List Images
        • Upload Image
        • Update Image Order
        • Delete Image
      • Product Availability Notifications
        • Notification Stats
        • Noticiation Settings
        • List Notifications
        • Create Notification
        • Update Settings
        • Send Notification Email
        • Export Notifications
      • Product Export
        • Email All Products to Store Owner
        • Import Products via CSV or xlsx File
      • Product Stock
        • Retrieve Product Stock
        • List Product Stock Records
        • Create Product Stock
        • Update Product Stock
        • Bulk Update Product Stock Records
      • Product Questions & Answers
        • Retrieve Product Question
        • Retrieve Product Answer
        • List Product Questions
        • List Answers for Question
        • Create Product Question
        • Create Product Answer
        • Update Product Question
        • Update Product Answer
        • Delete Product Question
        • Delete Product Answer
      • Product Reviews
        • List Reviews
        • Count Reviews
      • Digital Products
        • Create Downloadable Product
        • Generate Upload URL
        • Upload File to S3
        • Create Product Downloadable
        • Get Product Downloadables
        • Delete Product Downloadable
        • List Store Downloadables
        • Create Store Downloadable
        • Delete Store Downloadable
    • Inventories
      • Create Location
      • Update Location
      • Update Product Stock for Location
      • List Locations
      • View Location
    • Shipping
      • List Store Shipping Methods
    • Marketing
      • Coupons
        • List Coupons
        • View Coupon
        • Create Coupon
        • Generate Bulk Coupons
        • Duplicate Coupon
        • Duplicate Bulk Coupons
        • Update Coupon Note
        • Update Coupon
        • Update Bulk Coupons
        • Update Coupon Status
        • Update Bulk Coupons Status
        • Delete Coupon
        • Delete Bulk Coupons
      • Bundle Offers
        • List Bundle Offers
        • View Bundle Offer
      • Loyalty Program
        • Loyalty Program Status
        • Loyalty Program Details
        • Loyalty Program Info
        • Customer Loyalty Summary
        • Customer Points History
        • Activate Loyalty Program
        • Set Points Expiration Rules
        • Update Cashback Rule
        • Create Points Redemption Method
        • Update Points Redemption Method
        • Delete Points Redemption Method
        • Adjust Customer Points
      • Discount Rules
        • List Discount Rules
        • View Discount Rule
        • Create Discount Rule
        • Update Discount Rule
    • Customers
      • Customer Tags
        • List Customer Tags
        • Add Customer Tag
        • ْUpdate Customer Tag
        • Delete Customer Tag
      • List Customers
      • View Customer
      • Primary Customer List
      • FInd Customer By Phone Number
      • Customer Profile
      • Add Customer
      • Update Customer
      • Delete Customer
      • Add Bulk Customers
      • Import Customers
    • Store Settings
      • 📄 User Roles and Permissions
      • Retrieve Store Manager Profile
      • Retrieve VAT Settings
      • List Payment Methods
      • List Store Operating Countries
      • OneSignal Store Settings
      • Create or Update OneSignal Store Settings
    • Countries and Cities
      • List Countries
      • List Cities for Country
    • Blogs
      • Settings
        • Create
        • List
      • Categories
        • Create
        • List
        • Bulk Activate
        • Bulk Deactivate
        • Bulk Delete
        • Retrieve
        • Destroy
        • Partial Update
        • Bulk Add To Posts
        • Bulk Remove From Posts
      • Posts
        • Media
          • List
          • Create
          • Destroy
        • Create
        • List
        • Retrieve
        • Partial Update
        • Destroy
        • Archive
        • Publish
        • Bulk Archive
        • Bulk Publish
        • Bulk Delete
        • Export Posts
        • Import Template
        • Import Posts
      • Tags
        • Create
        • List
        • Retrieve
        • Partial Update
        • Destroy
        • Bulk Delete Tags
        • Bulk Add To Posts
        • Bulk Remove From Posts
      • Storefront
        • Posts
          • List
          • Retrieve
        • Categories
          • List
          • Retrieve
        • Tags
          • List
  • Webhooks
    • Overview
    • Webhook Health Tracking
    • Events
      • Order
      • Product
      • Abandoned Cart
      • Customer
      • Product Category
    • APIs
      • Health Summary
      • Broken Webhooks
      • Recover Broken Webhooks
      • List Webhooks
      • Create Webhook
      • Delete Webhook
      • Delete Webhook By subscriber
  • App Management
    • Events
    • APIs
      • Subscription Details
      • Update Usage-Based Charges
  1. Managing Products

Create Product

POST
https://api.zid.sa/v1/products/
Use this endpoint to create a new product in the store.
The Create Product endpoint supports multiple product classes, including standard products, grouped products, vouchers, downloadable products, crowdfunding projects, donation items, customizable products, and dynamic bundle products.
Some product classes require additional fields in the request body. Dynamic Bundle products require an additional step after product creation to configure selection groups.

Supported product classes#

Product ClassUse CaseAdditional Step Required
Standard ProductRegular physical or digital product.No
grouped_productBundle multiple existing products together as one product.No
voucherDigital voucher, gift card, or license key product.May require voucher setup after product creation.
downloadableDigital file product.Files are managed separately after product creation.
crowdfunding_projectFundraising product with goal tracking.No
donation_itemDonation product with unit-based progress tracking.No
dynamic_bundleCustomer-selectable bundle with selection groups.Yes. Selection groups must be created separately.
Customizable ProductProduct with custom input fields or custom option fields.No

Features#

Grouped products: Create a product that includes multiple existing products as a set.
Product badges: Optionally assign a badge to highlight offers, new arrivals, or other product attributes.
Variants: Add variants inline during product creation or create them later using the Add Product Variants endpoint.
Custom fields: Add customer input fields or predefined customization options during product creation.
Donation and crowdfunding products: Create products with progress tracking using product-specific metadata.
Dynamic bundles: Create a bundle product first, then configure its selection groups using the Dynamic Bundle selection groups endpoint.

Important Notes#

1.
Categories cannot be added during product creation.
To assign a product to one or more categories, use the following endpoints after creation:
Add a product to a certain category
Bulk Add Product to Category
2.
Dynamic Bundle products require at least one selection group before they can be published.
3.
If you create a Dynamic Bundle product as a draft, you can add selection groups later before publishing it.
4.
Some product classes restrict specific fields such as sale_price, quantity, is_infinite, or requires_shipping.
🔑Scopes
products.read_write - Products Read & Write

Dynamic Bundle flow#

Dynamic Bundle products require two API requests:
1.
Create the Dynamic Bundle product using POST /v1/products/
2.
Add selection groups using PATCH /v1/products/{product_id}/selection-groups/bulk-patch/
If the product is created as a draft, use this flow:
1.
Create the product as draft using POST /v1/products/
2.
Add selection groups using PATCH /v1/products/{product_id}/selection-groups/bulk-patch/
3.
Publish the product using PATCH /v1/products/{product_id}/
The Dynamic Bundle selection groups endpoint is currently not published.

Request

Header Params

Body Params application/json

Examples

Responses

🟢201OK
application/json
Bodyapplication/json

🟠401Unauthorized
🟠400Bad Request
🔴500Internal Server error
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location 'https://api.zid.sa/v1/products/' \
--header 'Authorization: {{Autherization}}' \
--header 'X-Manager-Token: {{Access-Token}}' \
--header 'Store-Id: {{StoreId}}' \
--header 'Accept-Language: en' \
--header 'Role: Manager' \
--header 'Content-Type: application/json' \
--data '{
  "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.00,
  "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}"
    }
  }
}'
Response Response Example
201 - Dynamic Bundle
{
    "id": "product-uuid",
    "name": {
        "ar": "حزمة البناء المخصصة",
        "en": "Custom Build Bundle"
    },
    "product_class": "dynamic_bundle",
    "sku": "BUNDLE-001",
    "price": 0,
    "is_draft": false,
    "is_published": false,
    "requires_shipping": true,
    "meta": {
        "location_id": "dd125776-70d1-4819-934c-a29b8ebd18ca"
    },
    "selection_groups": []
}
Modified at 2026-06-10 07:51:16
Previous
Create Product Types
Next
List Products
Built with