Datenschemas: Lager und Lagerorte

Datenschemas: Lager und Lagerorte. Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

Datenschemas

Auflisten · Lagerorte — Lager und Lagerorte — Antwort

ApiResponse_list_LocationData__ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataArray <LocationData > Erforderlich: Beispielantwort · ApiResponse_list_LocationData__.

Beispiel: [{"code":"example","created_at":"2026-01-01T12:00:00Z","id":"example","is_leaf":true,"location_type":"zone","name":"Example","parent_id":null,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Erforderlich: Metadaten der Antwort.

Beispiel: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Zusätzliche Felder: Nein

Auflisten — Lager und Lagerorte — Antwort

ApiResponse_list_WarehouseData__ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataArray <WarehouseData > Erforderlich: Beispielantwort · ApiResponse_list_WarehouseData__.

Beispiel: [{"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Erforderlich: Metadaten der Antwort.

Beispiel: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Zusätzliche Felder: Nein

Abrufen — Lager und Lagerorte — Antwort

ApiResponse_WarehouseData_ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataWarehouseData Erforderlich: Beispielantwort · WarehouseData.

Beispiel: {"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Erforderlich: Metadaten der Antwort.

Beispiel: {"request_id":"example"}

Zusätzliche Felder: Nein

Auflisten · Lagerorte — Lager und Lagerorte — Antwort

LocationData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

codeZeichenfolgeErforderlich

Stabiler maschinenlesbarer Code.

Beispiel: "example"

created_atZeichenfolgeErforderlich

Zeitpunkt der Erstellung.

format: "date-time"

Beispiel: "2026-01-01T12:00:00Z"

idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. (LocationData).

Beispiel: "example"

is_leafBoolescher WertErforderlich

Gibt an, ob die Kategorie keine Unterkategorien hat.

Beispiel: true

location_typeZeichenfolgeErforderlich

Typ des Lagerorts.

Einschränkungen

enum: ["zone", "rack", "shelf", "bin"]

Beispiel: "zone"

nameZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

Beispiel: "Example"

parent_idZeichenfolge nullErforderlich

Kennung der übergeordneten Kategorie.

Beispiel: null

updated_atZeichenfolgeErforderlich

Zeitpunkt der letzten Änderung.

format: "date-time"

Beispiel: "2026-01-01T12:00:00Z"

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

warehouse_idZeichenfolgeErforderlich

Lagerkennung.

Beispiel: "example"

Zusätzliche Felder: Nein

Lagerorte

LocationQuantity · Schema · Datenschemas: Lager und Lagerorte

location_idZeichenfolgeErforderlich

Kennung des Lagerorts.

Einschränkungen

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Beispiel: "example"

on_handGanzzahlErforderlich

Physischer Lagerbestand.

minimum: 0maximum: 2147483647

Beispiel: 1

Zusätzliche Felder: Nein

Abrufen — Lager und Lagerorte — Antwort

WarehouseData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

activeBoolescher WertErforderlich: Gibt an, ob die Ressource aktiv ist.

Beispiel: true
address_lineZeichenfolge nullErforderlich: Adresszeile.

Beispiel: "example"
cityZeichenfolge nullErforderlich: Stadt oder Ort.

Beispiel: "example"
codeZeichenfolgeErforderlich: Stabiler maschinenlesbarer Code.

Beispiel: "example"
country_codeZeichenfolgeErforderlich: Ländercode.

Beispiel: "PL"
created_atZeichenfolgeErforderlich: Zeitpunkt der Erstellung.

format: "date-time"

Beispiel: "2026-01-01T12:00:00Z"
customer_visibleBoolescher WertErforderlich: Gibt an, ob der Status für den Kunden sichtbar ist.

Beispiel: false
idZeichenfolgeErforderlich: Ressourcenkennung; unverändert aus der Antwort übernehmen. (WarehouseData).

Beispiel: "example"
nameZeichenfolgeErforderlich: Name der Ressource im jeweiligen Kontext.

Beispiel: "Example"
postal_codeZeichenfolge nullErforderlich: Postleitzahl.

Beispiel: "example"
updated_atZeichenfolgeErforderlich: Zeitpunkt der letzten Änderung.

format: "date-time"

Beispiel: "2026-01-01T12:00:00Z"
versionGanzzahlErforderlich: Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

Zusätzliche Felder: Nein