ADM-ASSORTMENT-550 - List assortments

get

https://example.com/v1/assortments

Returns a paginated, searchable, filterable list of assortments.

Scope

One row equals one assortment.
Includes counts for products and product variants linked to the assortment.

Search

Optional text search applied on:
- assortment name
- assortment external Id
- assortment Id

Filters

AND between different keys; OR between values of the same key. Unknown values are ignored; empty lists mean no filter.
Supported filters: externalSources, createMinDate, updateMinDate, navigationIds, productIds, variantIds,
productVariantCountMin, productVariantCountMax, productCountMin, productCountMax.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

Optional text search applied on: assortment name, assortment external Id, assortment Id;

externalSources

array of strings

Filter by external source(s) of the assortment.

Values must match ExternalSource enum names (NOT_DEFINED excluded).

Allowed values : CLIENT, EXTERN, MIRAKL

If an unknown value is provided, the result is empty.

externalSources

createMinDate

date-time

Return assortments with createdAt on or after this Instant (ISO-8601).

updateMinDate

date-time

Return assortments with updatedAt on or after this Instant (ISO-8601).

navigationIds

array of strings

Return assortments linked to at least one of the provided navigation IDs (OR semantics).

navigationIds

productIds

array of strings

Return assortments linked to at least one of the provided product IDs (OR semantics).

Multi-value parameter.

productIds

variantIds

array of strings

Return assortments linked to at least one of the provided variant IDs (OR semantics).

Multi-value parameter.

variantIds

productVariantCountMin

int32

≥ 0

Return assortments with productVariantCount >= this value.

productVariantCountMax

int32

≥ 0

Return assortments with productVariantCount <= this value.

productCountMin

int32

≥ 0

Return assortments with productCount >= this value.

productCountMax

int32

≥ 0

Return assortments with productCount <= this value.

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)

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:

*/*

200Assortments list successfully retrieved.