ADM-ASSORTMENT-570 - List assortment variants

get

https://example.com/v1/assortments/{id}/variants

Returns a paginated list of variants linked to a specific assortment.

Scope

One row equals one variant linked to the assortment.
Each row includes the associated product snapshot and variant snapshot.

Search

Optional text search applied on :
- product SKU
- product external Id
- product name
- variant SKU
- variant external Id
- variant name

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Assortment identifier.

Query Params

productId

string

Optional filter to return only variants belonging to the provided product identifier.

string

Optional text search applied on key product and variant fields.

product name, SKU, external id
variant name, SKU, external id

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

Headers

dj-client

string

enum

required

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.

Responses

401

Unauthorized (invalid or missing API key)

403

Forbidden (insufficient permissions)

404

Not found (unknown reference)

500

Internal server error

Language

Credentials

Bearer

JWT

Loading…

Response

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

*/*

200Assortment variants list successfully retrieved.