Get Store Downloadables Copy

Developing

GETv1/downloadables-library/

This endpoint retrieves a list of downloadable files associated with a specific store. It supports searching by file name and ordering the results by file size or creation date. The response provides details about each downloadable file, including its ID, name, file size, and associated store.

Request

Query Params

display_name

string

optional

A search keyword to filter files by their display name.

Example:

search display name

ordering

string

optional

Determines the sorting order of the results. Accepted values:
file_size: Orders the files by size in ascending order.
created_at: Orders the files by their creation date in ascending order.

Example:

file_size or created_at

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 eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.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

string

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 store.

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 {5}]

required

A list of downloadable file details.

string

required

Unique identifier for the downloadable file.

Example:

fcbbbf6e-74d4-439b-8425-2e382452bfe0

file

string

required

The file path in the storage system.

Example:

9fc92996-ffbe-4bca-9b8e-6682137fe7b6/product-downloadables/82a9062f-934c-4f05-933e-a0357f40c46d

display_name

string

required

The user-friendly name of the file.

Example:

fundementals of data engineering.pdf

store_id

string

required

The ID of the store to which the file belongs.

Example:

9fc92996-ffbe-4bca-9b8e-6682137fe7b6

file_size

integer

required

The size of the file in bytes.

Example:

278103

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "fcbbbf6e-74d4-439b-8425-2e382452bfe0",
      "file": "9fc92996-ffbe-4bca-9b8e-6682137fe7b6/product-downloadables/82a9062f-934c-4f05-933e-a0357f40c46d",
      "display_name": "fundementals of data engineering.pdf",
      "store_id": "9fc92996-ffbe-4bca-9b8e-6682137fe7b6",
      "file_size": 8939064
    },
    {
      "id": "7073e17c-183a-4903-ac37-6e7615162c7e",
      "file": "9fc92996-ffbe-4bca-9b8e-6682137fe7b6/product-downloadables/8244389b-8fe3-47dc-85ae-2f8e9e95f899",
      "display_name": "most-common-reasons-for-journal-rejections.pdf",
      "store_id": "9fc92996-ffbe-4bca-9b8e-6682137fe7b6",
      "file_size": 278103
    }
  ]
}

Last modified: 2 days ago