List articles

[ { "sku": "<string>", "deletedAt": "2023-11-07T05:31:56Z", "alternativeSkus": [ "<string>" ], "name": { "value": "<string>", "language": "DE" }, "articleType": "PRODUCT", "barcode": "<string>", "supplierReferenceNumber": "<string>", "alternativeBarcodes": [ "<string>" ], "grossWeight": { "value": 123, "unit": "KG" }, "netWeight": { "value": 123, "unit": "KG" }, "lotRequired": true, "expirationDateRequired": true, "serialNumberRequired": true, "canShipWithoutCarton": true, "length": { "value": 123, "unit": "M" }, "width": { "value": 123, "unit": "M" }, "height": { "value": 123, "unit": "M" }, "customsContentDescription": "<string>", "countryOfOrigin": "AF", "salesPrice": { "currencyCode": "<string>", "value": 123 }, "insuranceValue": { "currencyCode": "<string>", "value": 123 }, "customsValue": { "currencyCode": "<string>", "value": 123 }, "unNumber": "<string>", "customAttributes": "{\"attr1\":\"val1\"}", "itemGroup": "<string>", "lottableBatchRequired": true, "id": 123, "sellerId": 123, "articleIdentifier": "<string>", "images": [ { "source": "<string>", "id": "<string>", "url": { "link": "<string>" }, "packagingUnit": { "type": "PALLET", "barcode": "<string>", "piecesPerPackagingUnit": 123, "grossWeight": { "value": 123, "unit": "KG" }, "netWeight": { "value": 123, "unit": "KG" }, "length": { "value": 123, "unit": "M" }, "width": { "value": 123, "unit": "M" }, "height": { "value": 123, "unit": "M" } } } ], "minimumQuantities": [ { "warehouseId": 123, "quantity": 123, "calculationMode": "<string>" } ], "packagingUnits": [ { "type": "PALLET", "barcode": "<string>", "piecesPerPackagingUnit": 123, "grossWeight": { "value": 123, "unit": "KG" }, "netWeight": { "value": 123, "unit": "KG" }, "length": { "value": 123, "unit": "M" }, "width": { "value": 123, "unit": "M" }, "height": { "value": 123, "unit": "M" } } ], "minimumExpirationDates": [ { "notifyDaysBeforeExpiration": 2, "warehouseId": 123 } ], "minimumShelfLives": [ { "minimumShelfLife": 2, "warehouseId": 123 } ], "tariffNumber": "<string>", "lengthM": 123, "widthM": 123, "heightM": 123, "grossWeightKG": 123, "netWeightKG": 123, "sort": { "short": true, "nodeType": "ARRAY", "float": true, "binary": true, "number": true, "integralNumber": true, "boolean": true, "double": true, "long": true, "int": true, "valueNode": true, "containerNode": true, "missingNode": true, "object": true, "pojo": true, "floatingPointNumber": true, "bigDecimal": true, "bigInteger": true, "textual": true, "array": true, "null": true } } ]

Query Parameters

query

string

Search query string used to filter results. This field supports specific syntax for filtering across multiple fields.

sort

string

Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc').

page

integer<int64>

The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided.

searchAfter

string

Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'.

pageSize

integer<int64>

The maximum number of items to return per page. Used for both offset and cursor-based pagination.

Response

Returns an array of ArticleGetSummary matching the request criteria.

sku

string

required

Stock Keeping Unit (SKU) identifier

Required string length: 1 - 50

deletedAt

string<date-time>

The deleted at timestamp

alternativeSkus

string[]

Stock Keeping Unit (SKU) identifier

name

object

Detailed information for stringi18n

Show child attributes

articleType

enum<string>

The type or category of the article (product).

Available options:

PRODUCT,

CARTON

barcode

string

Code or identifier

Maximum string length: 50

supplierReferenceNumber

string

Reference number provided by the supplier for this article.

Maximum string length: 20

alternativeBarcodes

string[]

Code or identifier

grossWeight

object

Detailed information for weight

Show child attributes

netWeight

object

Detailed information for weight

Show child attributes

lotRequired

boolean

Indicates whether lot is required

expirationDateRequired

boolean

Indicates whether an expiration date is required for this article.

serialNumberRequired

boolean

Indicates whether serial number is required

canShipWithoutCarton

boolean

Boolean flag indicating can ship without carton

length

object

Detailed information for lengthmeasurement

Show child attributes

width

object

Detailed information for lengthmeasurement

Show child attributes

height

object

Detailed information for lengthmeasurement

Show child attributes

customsContentDescription

string

Description text

countryOfOrigin

enum<string>

Country code or name

Available options:

AF,

AX,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

CI,

HR,

CU,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

XK,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SK,

SI,

SB,

SO,

ZA,

GS,

ES,

LK,

SD,

SR,

SJ,

CW,

BQ,

SX,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW

salesPrice

object

Detailed information for monetaryvalue

Show child attributes

insuranceValue

object

Detailed information for monetaryvalue

Show child attributes

customsValue

object

Detailed information for monetaryvalue

Show child attributes

unNumber

string

Number value

customAttributes

object

Optional value for custom attributes of article.

Show child attributes

Example:

"{\"attr1\":\"val1\"}"

itemGroup

string

The item group

lottableBatchRequired

boolean

Indicates whether lottable batch is required

integer<int64>

The unique identifier for the article.

sellerId

integer<int64>

The unique identifier for the seller

articleIdentifier

string

The unique identifier for the articleentifier

images

object[]

Image reference

Show child attributes

minimumQuantities

object[]

Array of minimum quantitie

Show child attributes

packagingUnits

object[]

Array of packaging unit

Show child attributes

minimumExpirationDates

object[]

Minimum expiration dates required for this article.

Show child attributes

minimumShelfLives

object[]

Array of minimum shelf live

Show child attributes

tariffNumber

string

Number value

lengthM

number

Length measurement

widthM

number

Width measurement

heightM

number

Height measurement

grossWeightKG

number

Weight value

netWeightKG

number

Weight value

sort

object

The

Show child attributes

Introduction

Endpoints

Query Parameters

Response