Get paginated offer inventories

get

https://example.com/v1/offer-inventories

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

productVariantId

string

offerIdentifier

string

Free-text search across multiple fields. Matches:

offer external id (exact match, locale-independent)
offer Djust id (exact match, locale-independent)
product name (localized, substring, case- and accent-insensitive — only when locale is provided)
product SKU (substring, case- and accent-insensitive — only when locale is provided)
supplier name (substring, case- and accent-insensitive — only when locale is provided)

locale

string

priceMin

number

priceMax

number

supplierIds

array of strings

supplierIds

stockMin

int32

stockMax

int32

status

array of objects

status

Allowed:

createMinDate

date-time

updateMinDate

date-time

customerAccountIds

array of strings

customerAccountIds

externalSource

string

enum

Allowed:

customerTagIds

array of strings

customerTagIds

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

idType

string

Defaults to DJUST_ID

               The `idType` query parameter enforces the following rules:
                                                 This parameter applies to all entities in the API.

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:

*/*

200Offer inventories get with success