Get Collection Preview Url - Depict Documentation

Error

A valid request URL is required to generate request examples

{
  "status": "success",
  "render_url": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

/

collections

/

{collection_id}

/

preview-url

Error

A valid request URL is required to generate request examples

{
  "status": "success",
  "render_url": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

collection_id

string

required

Query Parameters

version

string<uuid> | null

merchant_id

string

required

Body

application/json

template_suffix

string

required

products_cache_key

string[]

required

width

integer

default:1000

Required range: 100 <= x <= 4000

password

string | null

Response

Successful Response

GetCollectionPreviewUrlSuccessResponse
GetCollectionPreviewUrlWrongPasswordErrorResponse

status

enum<string>

required

Available options:

success

Allowed value: "success"

render_url

string

required