Get Product Downloadables

Developing

GETv1/products/{{product-id}}/downloadables/

This endpoint retrieves a list of downloadable files associated with a specific product, providing details about each downloadable file, including access URLs, display names, and status. The response includes pagination information and metadata about the files, allowing the client to manage multiple files for a product.

Request

Header Params

Authorization

string

required

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:

Bearer eyJ0e9AiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y

Store-Id

integer

optional

Unique identifier of the store.

Example:

1235

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:

eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=

Role

string

optional

Role of the user.

Example:

Manager

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

Request samples

Responses

OK(200)

HTTP Code: 200

Content Type : JSONapplication/json

count

integer

required

The total number of downloadable files available for the product.

Example:

null

required

URL to the next page of results, or null if there are no additional pages.

null

required

URL to the previous page of results, or null if there are no previous pages.

results

array [object {7}]

required

A list of downloadable file details.

string

required

Unique identifier for the downloadable file.

Example:

f2f3ff33-a68e-498a-a052-0ea1bbddc144

product_id

string

required

The ID of the product linked to the downloadable file.

Example:

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

file

object

required

Provides access and metadata details for the file.

display_name

string

required

The user-friendly name of the file for display.

Example:

most-common-reasons-for-journal-rejections

display_order

null

required

Optional ordering value to specify the display sequence among files.

is_enabled

boolean

required

Indicates if the file is available for download.

Default:

true

is_external

boolean

required

Defines if the file is hosted externally or within the primary storage system.

Default:

true

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "f2f3ff33-a68e-498a-a052-0ea1bbddc144",
      "product_id": "5af835b7-1a37-4401-a3fc-6d9007c44c8f",
      "file": {
        "url": "https://www.editage.com/info/file/most-common-reasons-for-journal-rejections.pdf"
      },
      "display_name": "most-common-reasons-for-journal-rejections",
      "display_order": null,
      "is_enabled": true,
      "is_external": true
    },
    {
      "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=Mx5DhYy4dA7nTUbTnB%2BeBFM0gFg%3D&Expires=1730614728",
        "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
    }
  ]
}

Last modified: 2 days ago