Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

Create Product Downloadable

POST

https://api.zid.sa/v1/products/{{product-id}}/downloadables/

This endpoint creates downloadable content for a digital product, associating a file with the specified product. The download link is generated and returned, allowing users to access or download the content directly. The response provides information on the uploaded file, including its metadata, access link, and display details.

🔑Scopes

products.read_write - Products Read & Write

Request

Header Params

Body Params application/json

Example

{
    "file": "9fc92996-ffbe-4bca-9b8e-6682137fe7b6/product-downloadables/8244389b-8fe3-47dc-85ae-2f8e9e95f899",
    "display_name": "most-common-reasons-for-journal-rejections.pdf",
    "save_to_library": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://api.zid.sa/v1/products/{{product-id}}/downloadables/' \
--header 'Authorization: {{Autherization}}' \
--header 'Store-Id: 3' \
--header 'Accept-Language: en' \
--header 'X-manager-Token: {{Access-Token}}' \
--header 'Role: Manager' \
--header 'Currency: SAR' \
--header 'Content-Type: application/json' \
--data-raw '{
    "file": "9fc92996-ffbe-4bca-9b8e-6682137fe7b6/product-downloadables/8244389b-8fe3-47dc-85ae-2f8e9e95f899",
    "display_name": "most-common-reasons-for-journal-rejections.pdf",
    "save_to_library": true
}'

Responses

🟢201Created

application/json

Body

Example

{
    "id": "1c044189-9155-4d51-aef1-22c8d3edd7ba",
    "product_id": "5af835b7-1a37-4401-a3fc-6d9007c44c8f",
    "file": {
        "key": "9fc92996-ffbe-4bca-9b8e-6682137fe7b6/product-downloadables/8244389b-8fe3-47dc-85ae-2f8e9e95f899",
        "url": "https://s3.eu-west-1.amazonaws.com/private.zid.store/9fc92996-ffbe-4bca-9b8e-6682137fe7b6/product-downloadables/8244389b-8fe3-47dc-85ae-2f8e9e95f899?response-content-disposition=inline%3B%20filename%3D%22most-common-reasons-for-journal-rejections.pdf%22&AWSAccessKeyId=AKIAXOL3MW23VCA3WLDK&Signature=vZI5mUsstSI2hT4lL957lFun%2F%2BM%3D&Expires=1730614548",
        "meta": {
            "content_length": 278103,
            "content_type": "binary/octet-stream",
            "content_encoding": null
        }
    },
    "display_name": "most-common-reasons-for-journal-rejections.pdf",
    "display_order": null,
    "is_enabled": true,
    "is_external": false
}

🟠401Unauthorized

🔴500Internal Server error

🟠404Not Found

Modified at 2026-02-06 07:25:17

Upload File to S3

Get Product Downloadables