Create Downloadable Product
DevelopingPOSTv1/products/The "Create Downloadable Product" endpoint allows users to add a new digital product to their store. This endpoint enables specifying product details, such as name, price, SKU, and download settings, to configure the product for digital delivery without shipping requirements. The response includes product metadata, availability, and stock settings relevant to digital products.
Request
Unique identifier of the store.
Preferred language for the response. Defaults to en if not specified.
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.
The currency in which the data should be returned. This should be provided as an ISO 4217 currency code. For example, SAR for Saudi Riyal, USD for United States Dollar, KWD for Kuwaiti Dinar, etc.
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 on how to obtain the Access-Token.
Role of the user.
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.
Request samples
Responses
Unique identifier for the product.
Specifies the type of product.
Stock Keeping Unit.
Barcode assigned to the product.
Identifier for the parent product.
Product name object.
Name in Arabic.
A URL-friendly identifier for the product.
The regular price of the product.
A brief description of the product.
Discounted price for the product if applicable.
The formatted display of the product’s price including currency symbol.
Display for the sale price with currency symbol.
Currency code for the product’s price.
Symbol for the currency.
Array containing custom attributes associated with the product.
Categories the product belongs to, helps with organization and searchability.
Specifies the product’s display order on listing pages, null if no custom order is set.
Boolean indicating if the product has selectable options, such as size or color.
Boolean indicating if the product requires custom user input fields.
Array of images associated with the product, empty here as this is a downloadable product.
Indicates whether the product is saved as a draft, allowing incomplete products to be saved without publishing.
Available quantity for the product.
Boolean indicating unlimited stock availability.
Public URL for accessing the product on the storefront.
Weight of the product, including value and unit (e.g., "kg").
Array of keywords associated with the product to improve searchability.
Boolean indicating whether the product requires shipping.
Boolean indicating whether the product is subject to tax.
Product structure type, such as standalone or bundled.
Search engine optimization information for the product.
Object with rating details, including average rating and counts of ratings across different levels.
Identifier of the store selling this product.
Object detailing any purchase limits, such as minimum or maximum quantities, availability period, and sale price duration.
Custom fields associated with the product.
Additional product metadata, such as download_limit and expiration_period, which are specific to digital products.
Specifies how related products are generated.
Title for the related products section.
Promotional badge associated with the product.
Array of product variants.
Cost of the product.
Boolean indicating if the product is live and visible to customers.
Number of customers waiting for the product.
Full description of the product, usually longer and more detailed.
Array for custom fields requiring user input.
Array for custom options associated with the product.
Product options available to customers.
Array of related products.
Identifier of the next product in the listing.
Identifier of the previous product in the listing.
Array for grouped products.
Array of stock locations and available quantity for each location, set to infinite for downloadable products.
Count of products sold.
Timestamp indicating when the product was created.
Timestamp indicating the last time the product was updated.
{
"id": "5af835b7-1a37-4401-a3fc-6d9007c44c8f",
"product_class": "downloadable",
"sku": "Z.484979.17300084114100137",
"barcode": "",
"parent_id": null,
"name": {
"ar": "downloadable product"
},
"slug": "downloadable-product",
"price": 2,
"short_description": null,
"sale_price": null,
"formatted_price": "2.00 ر.س ",
"formatted_sale_price": null,
"currency": "SAR",
"currency_symbol": " ر.س ",
"attributes": [],
"categories": [],
"display_order": null,
"has_options": false,
"has_fields": false,
"images": [],
"is_draft": false,
"quantity": null,
"is_infinite": true,
"html_url": "https://j1wfge.zid.store/products/downloadable-product",
"weight": {
"value": null,
"unit": "kg"
},
"keywords": [],
"requires_shipping": false,
"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": 484979,
"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": null,
"meta": {
"download_limit": null,
"expiration_period": null
},
"related_products_settings": "AUTO_GENERATED",
"related_products_title": null,
"badge": null,
"variants": [],
"cost": null,
"is_published": true,
"waiting_customers_count": null,
"description": null,
"custom_user_input_fields": [],
"custom_option_fields": [],
"options": [],
"related_products": [],
"next_product": null,
"previous_product": null,
"group_products": null,
"stocks": [
{
"id": "36173f2b-f412-4b48-89bd-43d7733daf80",
"location": {
"id": "4e67872b-3483-4615-8fec-0cc4f9efc064",
"name": {
"ar": "المخزون الأساسي"
},
"type": "PHYSICAL",
"full_address": "RGRB7496, 7496 Al Raht, 3901ØŒ ØÙŠ الرØمانية، Riyadh 12341, Saudi Arabia"
},
"available_quantity": null,
"is_infinite": true
}
],
"sold_products_count": null,
"created_at": "2024-10-27T05:53:31.411987Z",
"updated_at": "2024-10-27T05:53:31.412015Z"
}