Create Downloadable Product

Here’s the updated description with the additional clarification:

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 process is the same as creating any other product, with the key distinction being the inclusion of 'product_class': 'downloadable' in the request payload. The response includes product metadata, availability, and stock settings relevant to digital products.

🔑Scopes

products.read_write - Products Read & Write

Request

Header Params

Store-Id

integer

optional

Unique identifier of the store.

Example:

Accept-Language

string

optional

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

Example:

X-manager-Token

string

optional

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:

eyJpdiI6ImNSZ0NKWXlMZ3hEcDZudU1wS3R1dVE9PSIsInZhbHVlIjoiZnRqdGRVUE1IdU9PaytvSk1pbGV5Zk5YUk9pRG9ONWVwa1NaTUIvN0JkYzgwNlFUV3h6ZCs5S2VkRDVaSy9GbWRDQm9adlR4SEFHMStpUDNuM1V1dG9PUENCZ0R6eHJYeEZHLzhzMFlWb25NMHI3TE1NZDIzbnNEQlI3ekNycE5RVHVBczQ2L1FKSjF1UTI3Q0xzaXNtcmM1Mi9LUHc3aDEvV0J6R2ZyUkJCT0lrbXg3c0NiN0JEL1RvWFlSSWZ4M1J2MVhiRWZZcUdXMGI3NVJlMXA0aFNlcE02Z1RPak43Ump6Z1BQdEpnMD0iLCJtYWMiOiIxZmU2YzlmYWE1NTE0OTQwNDFmMTkxYzdhNGM0Zjk2NDgyYjI4ZWM2NjlkODU3NTI4NzM1NTY0YmVkZjMxNzc5IiwidGFnIjoiIn0=:

Currency

string

optional

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.

Example:

SAR

Access-Token

string

optional

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.

Example:

Role

string

optional

Role of the user.

Example:

Manager

Authorization

string

optional

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:

eyJ0fXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIzIiwianRpIjoiMTQyZjEyYTVlY2JhNzIyZTZlMjkwZjVlZDRhNmEwZDk1N2M4MGM3ZTVhODE4MjMyMjhjMzk0YjkyMGFkMmQ2ZDFkODI2YTYxOTI3MTEwMzUiLCJpYXQiOjE3MTA5NzY3MDYuNzUwOTI0LCJuYmYiOjE3MTA5NzY3MDYuNzUwOTI3LCJleHAiOjE3NDI1MTI3MDYuNzA2OTc5LCJzdWIiOiIzIiwic2NvcGVzIjpbIioiXX0.k2xkXywMs4eFArabnVFPH2CfBdMT1M-x0i6xGxM_OfUqKpFRxlTxj7tapbuSKDa2e-lyVr9AZwuCidj-5v1WQjYgj_bYRE-bi4CvGgY9reSVRy5l5a7i19nXNWyDfYHc_20CgMwrAUVlJoZLUkrQ3O6dAdjo83aoyktTKKfI7Q3-iWdFPAEzby_1pU5T883whYEWwfXWGzICwDQzulQzLm7dSAOy2xUNdB2CHn0tHCNHeaY8Mx11MBABAw_RVPZddR7kDOf5jc1g6fJ9YYGeru1ptZPwK2vHlRLnVJdbN5f4byE77LEVyb3daWuv3sYeIdEV3eV9WLmeGt0FlOjxpTHpEqBN4t1np6vV5nZyoluP9SuDXt5wKI7o3uPhat8vZ4B8pc-35484Y5_RxHyP2fxgQStqLFvMypJGoLMh2zg39sUP3oI35R1bIadKt49MM2c-RjP-16ngbK6np104hdFYojelf9EFRN9tY-yIUEyg5fWLw6mIBOxDFcqjZRUc-3P5VPgdeacp0-oU968YB1gP3155Dsu8DVxDr-iuQ5deusTpYnFlqokJ26VknHRJSMxlVBWptljv9EHNFw6a5gvcj8xht5ldm4b9RqisxUC0OlwJtK_pmhp-srp6biaj54u9zIvjKd-seJNumF1VM2nfJk63TnfPZbG9SLyPjuU

Body Params application/json

name

object

required

Product name object.

string

required

Name in Arabic.

Example:

منتج قابل للتنزيل

string

required

Name in English.

Example:

downloadable product

price

integer

required

The regular price of the product.

Example:

is_draft

boolean

required

Indicates whether the product is in a draft state.

Default:

true

product_class

string

required

Specifies the type of product.

Example:

downloadable

Example

{
    "name": {
        "ar": "منتج قابل للتنزيل",
        "en": "downloadable product"
    },
    "price": 2,
    "is_draft": true,
    "product_class": "downloadable"
}

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 'Store-Id: 3' \
--header 'Accept-Language: ar' \
--header 'X-manager-Token: eyJpdiI6ImNSZ0NKWXlMZ3hEcDZudU1wS3R1dVE9PSIsInZhbHVlIjoiZnRqdGRVUE1IdU9PaytvSk1pbGV5Zk5YUk9pRG9ONWVwa1NaTUIvN0JkYzgwNlFUV3h6ZCs5S2VkRDVaSy9GbWRDQm9adlR4SEFHMStpUDNuM1V1dG9PUENCZ0R6eHJYeEZHLzhzMFlWb25NMHI3TE1NZDIzbnNEQlI3ekNycE5RVHVBczQ2L1FKSjF1UTI3Q0xzaXNtcmM1Mi9LUHc3aDEvV0J6R2ZyUkJCT0lrbXg3c0NiN0JEL1RvWFlSSWZ4M1J2MVhiRWZZcUdXMGI3NVJlMXA0aFNlcE02Z1RPak43Ump6Z1BQdEpnMD0iLCJtYWMiOiIxZmU2YzlmYWE1NTE0OTQwNDFmMTkxYzdhNGM0Zjk2NDgyYjI4ZWM2NjlkODU3NTI4NzM1NTY0YmVkZjMxNzc5IiwidGFnIjoiIn0=:' \
--header 'Currency: SAR' \
--header 'Access-Token: eyJpdiI6ImNSZ0NKWXlMZ3hEcDZudU1wS3R1dVE9PSIsInZhbHVlIjoiZnRqdGRVUE1IdU9PaytvSk1pbGV5Zk5YUk9pRG9ONWVwa1NaTUIvN0JkYzgwNlFUV3h6ZCs5S2VkRDVaSy9GbWRDQm9adlR4SEFHMStpUDNuM1V1dG9PUENCZ0R6eHJYeEZHLzhzMFlWb25NMHI3TE1NZDIzbnNEQlI3ekNycE5RVHVBczQ2L1FKSjF1UTI3Q0xzaXNtcmM1Mi9LUHc3aDEvV0J6R2ZyUkJCT0lrbXg3c0NiN0JEL1RvWFlSSWZ4M1J2MVhiRWZZcUdXMGI3NVJlMXA0aFNlcE02Z1RPak43Ump6Z1BQdEpnMD0iLCJtYWMiOiIxZmU2YzlmYWE1NTE0OTQwNDFmMTkxYzdhNGM0Zjk2NDgyYjI4ZWM2NjlkODU3NTI4NzM1NTY0YmVkZjMxNzc5IiwidGFnIjoiIn0=:' \
--header 'Role: Manager' \
--header 'Authorization: eyJ0fXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIzIiwianRpIjoiMTQyZjEyYTVlY2JhNzIyZTZlMjkwZjVlZDRhNmEwZDk1N2M4MGM3ZTVhODE4MjMyMjhjMzk0YjkyMGFkMmQ2ZDFkODI2YTYxOTI3MTEwMzUiLCJpYXQiOjE3MTA5NzY3MDYuNzUwOTI0LCJuYmYiOjE3MTA5NzY3MDYuNzUwOTI3LCJleHAiOjE3NDI1MTI3MDYuNzA2OTc5LCJzdWIiOiIzIiwic2NvcGVzIjpbIioiXX0.k2xkXywMs4eFArabnVFPH2CfBdMT1M-x0i6xGxM_OfUqKpFRxlTxj7tapbuSKDa2e-lyVr9AZwuCidj-5v1WQjYgj_bYRE-bi4CvGgY9reSVRy5l5a7i19nXNWyDfYHc_20CgMwrAUVlJoZLUkrQ3O6dAdjo83aoyktTKKfI7Q3-iWdFPAEzby_1pU5T883whYEWwfXWGzICwDQzulQzLm7dSAOy2xUNdB2CHn0tHCNHeaY8Mx11MBABAw_RVPZddR7kDOf5jc1g6fJ9YYGeru1ptZPwK2vHlRLnVJdbN5f4byE77LEVyb3daWuv3sYeIdEV3eV9WLmeGt0FlOjxpTHpEqBN4t1np6vV5nZyoluP9SuDXt5wKI7o3uPhat8vZ4B8pc-35484Y5_RxHyP2fxgQStqLFvMypJGoLMh2zg39sUP3oI35R1bIadKt49MM2c-RjP-16ngbK6np104hdFYojelf9EFRN9tY-yIUEyg5fWLw6mIBOxDFcqjZRUc-3P5VPgdeacp0-oU968YB1gP3155Dsu8DVxDr-iuQ5deusTpYnFlqokJ26VknHRJSMxlVBWptljv9EHNFw6a5gvcj8xht5ldm4b9RqisxUC0OlwJtK_pmhp-srp6biaj54u9zIvjKd-seJNumF1VM2nfJk63TnfPZbG9SLyPjuU' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": {
        "ar": "منتج قابل للتنزيل",
        "en": "downloadable product"
    },
    "price": 2,
    "is_draft": true,
    "product_class": "downloadable"
}'

Responses

🟢200Success

application/json

Body

string

required

Unique identifier for the product.

Example:

5af835b7-1a37-4401-a3fc-6d9007c44c8f

product_class

string

required

Specifies the type of product.

Example:

downloadable

sku

string

required

Stock Keeping Unit.

Example:

Z.484979.17300084114100137

barcode

string

required

Barcode assigned to the product.

Example:

[]

parent_id

null

required

Identifier for the parent product.

name

object

required

Product name object.

string

required

Name in Arabic.

Example:

downloadable product

slug

string

required

A URL-friendly identifier for the product.

Example:

downloadable-product

price

integer

required

The regular price of the product.

Example:

short_description

null

required

A brief description of the product.

sale_price

null

required

Discounted price for the product if applicable.

formatted_price

string

required

The formatted display of the product’s price including currency symbol.

Example:

2.00 ر.س

formatted_sale_price

null

required

Display for the sale price with currency symbol.

currency

string

required

Currency code for the product’s price.

Example:

SAR

currency_symbol

string

required

Symbol for the currency.

Example:

ر.س

attributes

array[string]

required

Array containing custom attributes associated with the product.

meta

object

required

Additional product metadata, such as download_limit and expiration_period, which are specific to digital products.

download_limit

null

required

expiration_period

null

required

related_products_settings

string

required

Specifies how related products are generated.

Example:

AUTO_GENERATED

related_products_title

null

required

Title for the related products section.

badge

null

required

Promotional badge associated with the product.

variants

array[string]

required

Array of product variants.

cost

null

required

Cost of the product.

is_published

boolean

required

Boolean indicating if the product is live and visible to customers.

Default:

true

waiting_customers_count

null

required

Number of customers waiting for the product.

description

null

required

Full description of the product, usually longer and more detailed.

custom_user_input_fields

array[string]

required

Array for custom fields requiring user input.

custom_option_fields

array[string]

required

Array for custom options associated with the product.

options

array[string]

required

Product options available to customers.

related_products

array[string]

required

Array of related products.

next_product

null

required

Identifier of the next product in the listing.

previous_product

null

required

Identifier of the previous product in the listing.

group_products

null

required

Array for grouped products.

stocks

array [object {4}]

required

Array of stock locations and available quantity for each location, set to infinite for downloadable products.

string

optional

Example:

36173f2b-f412-4b48-89bd-43d7733daf80

location

object

optional

available_quantity

null

optional

is_infinite

boolean

optional

Default:

true

sold_products_count

null

required

Count of products sold.

created_at

string

required

Timestamp indicating when the product was created.

Example:

2024-10-27T05:53:31.411987Z

updated_at

string

required

Timestamp indicating the last time the product was updated.

Example:

2024-10-27T05:53:31.412015Z

Example

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