Create a download resource

Create a download resource which will get populated with a signed url async. Only one of orderitem or catalog id should be populated in a single request.

POST/v0/catalogs/download

Authorisations

AuthorizationString

Request Body

catalog_idsstring[]required

do not supply order_item_ids if this field is usedExample: ["47435e2b-d8c4-51ff-9de9-2be3bfc92276"]

order_item_idsstring[]required

do not supply catalog_ids if this field is used

Response

application/json

Created

idstring

Example: "47435e2b-d8c4-41ff-9de9-2be3bfc92276"

signed_urlstring

Example: "http://signed_url_link"

statusstring

Example: "success"

Create a download resourcecURL
Python
Go
TypeScript
1curl -X POST 'https://api.pixxel.space/v0/catalogs/download' \
2  -H 'Authorization: YOUR_API_KEY' \
3  -H 'Content-Type: application/json' \
4  -d '{
5  "catalog_ids": [
6    "47435e2b-d8c4-51ff-9de9-2be3bfc92276"
7  ],
8  "order_item_ids": [
9    "string"
10  ]
11}'

Response:

{
  "id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
  "signed_url": "http://signed_url_link",
  "status": "success"
}