Add variants to a catalog view

post

https://example.com/v1/catalog-views/{id}/product-variants

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Query Params

idType

string

enum

idType applies to ALL identifiers in this request.

idType=DJUST_ID: the path {id} is a business catalog view ID and the body 'variantIds' are business product variant IDs.
idType=EXTERNAL_ID: the path {id} is an external catalog view ID and the body 'variantIds' are external product variant IDs.

Allowed:

Body Params

Request payload to add product variants to a catalog view. The values in 'variantIds' must correspond to the identifier type specified by the 'idType' query parameter:

idType=DJUST_ID: 'variantIds' are business product variant IDs.
idType=EXTERNAL_ID: 'variantIds' are external product variant IDs.

variantIds

array of strings

variantIds

Headers

dj-client

string

enum

required

Specifies the client type making the request.

OPERATOR: Platform operator user.
ACCOUNT: Customer account user.
SUPPLIER: Supplier managing orders.

Allowed:

dj-api-key

string

required

API key required for authentication. Must be valid and linked to the requesting user.

dj-store

string

(Optional) Store ID in multi-store environments.

dj-store-view

string

(Optional) Store view ID in multi-store environments.

Response

201Variants added to catalog view