v1

latestOpenAPI 3.0.02026-08-0455133277.1 KB
Catalog

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

Request body

catalog_idsstring[] required

do not supply order_item_ids if this field is used

order_item_idsstring[] required

do not supply catalog_ids if this field is used

Example request

{
  "catalog_ids": [
    "47435e2b-d8c4-51ff-9de9-2be3bfc92276"
  ]
}

Response

Created

idstring
signed_urlstring
status'success' | 'created' | 'failed' | 'in_progress'

Example response

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