Fetch a catalog view product variants

get

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

Fetches product variants for a catalog view. If no sort parameter is provided, results are sorted by product external ID (ascending), then by variant external ID (ascending).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Query Params

idType

string

enum

The idType query parameter enforces the following rules:

idType=DJUST_ID: The id in the path refers to a business catalog view ID.
idType=EXTERNAL_ID: The id in the path refers to an external catalog view ID.

Allowed:

page

integer

≥ 0

Defaults to 0

Zero-based page index (0..N)

size

integer

≥ 1

Defaults to 20

The size of the page to be returned

sort

array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Format: property:direction (recommended) or property,direction (kept for backward compatibility).

sort

string

productId

string

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

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200Catalog view product variants fetched