Sign in

v1

latestOpenAPI 3.1.02026-07-1342112262.5 KB
Items

List items

List items

Required scope: business/catalogue:read

Deprecated alias: business/products:read (still accepted, will be removed in a future release)

get/v1/items/

Query parameters

created_at__gtestring date-time nullable

The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

Example:2024-11-19T15:27:02+00:00

The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

created_at__ltestring date-time nullable

The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

Example:2024-11-19T15:27:02+00:00

The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

updated_at__gtestring date-time nullable

The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

Example:2024-11-19T15:27:02+00:00

The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

updated_at__ltestring date-time nullable

The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

Example:2024-11-19T15:27:02+00:00

The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

cursorstring nullable

A pagination cursor from where results should start being fetched.

A pagination cursor from where results should start being fetched.

limitinteger

The maximum number of results to return.

The maximum number of results to return.

expandExpandableItem[]

Specifies which related entities to inflate in the response. Repeat the parameter to expand multiple entities, e.g. ?expand=brand&expand=category. By default, related entities are returned only as identifiers (e.g. brand_id, category_id).

Specifies which related entities to inflate in the response. Repeat the parameter to expand multiple entities, e.g. ?expand=brand&expand=category. By default, related entities are returned only as identifiers (e.g. brand_id, category_id).

location_idstring nullable

Filter items to those available at this location, and resolve variant prices for that location.

Filter items to those available at this location, and resolve variant prices for that location.

Response

Successful Response

next_cursorstring nullable required

A pagination cursor that can be used to retrieve the next set of results.

Example response

{
  "data": [],
  "next_cursor": "1323935095007282836"
}