Datascheman: Lager och lagerplatser

Datascheman: Lager och lagerplatser. Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

Datascheman

Lista · Platser — Lager och lagerplatser — Svar

ApiResponse_list_LocationData__ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataArray <LocationData > Obligatoriskt: Exempel på svar · ApiResponse_list_LocationData__.

Exempel: [{"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 Obligatoriskt: Metadata för svaret.

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

Ytterligare fält: Nej

Lista — Lager och lagerplatser — Svar

ApiResponse_list_WarehouseData__ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataArray <WarehouseData > Obligatoriskt: Exempel på svar · ApiResponse_list_WarehouseData__.

Exempel: [{"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 Obligatoriskt: Metadata för svaret.

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

Ytterligare fält: Nej

Hämta — Lager och lagerplatser — Svar

ApiResponse_WarehouseData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataWarehouseData Obligatoriskt: Exempel på svar · WarehouseData.

Exempel: {"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 Obligatoriskt: Metadata för svaret.

Exempel: {"request_id":"example"}

Ytterligare fält: Nej

Lista · Platser — Lager och lagerplatser — Svar

LocationData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

codeSträngObligatoriskt

Stabil maskinläsbar kod.

Exempel: "example"

created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"

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

idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (LocationData).

Exempel: "example"

is_leafBooleskt värdeObligatoriskt

Anger om kategorin saknar underkategorier.

Exempel: true

location_typeSträngObligatoriskt

Typ av lagerplats.

Begränsningar

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

Exempel: "zone"

nameSträngObligatoriskt

Resursens namn i aktuell kontext.

Exempel: "Example"

parent_idSträng nullObligatoriskt

Identifierare för överordnad kategori.

Exempel: null

updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"

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

versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

warehouse_idSträngObligatoriskt

Lagrets identifierare.

Exempel: "example"

Ytterligare fält: Nej

Lagerplatser

LocationQuantity · Schema · Datascheman: Lager och lagerplatser

location_idSträngObligatoriskt

Lagerplatsens identifierare.

Begränsningar

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

Exempel: "example"

on_handHeltalObligatoriskt

Fysiskt antal i lager.

minimum: 0maximum: 2147483647

Exempel: 1

Ytterligare fält: Nej

Hämta — Lager och lagerplatser — Svar

WarehouseData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

activeBooleskt värdeObligatoriskt: Anger om resursen är aktiv.

Exempel: true
address_lineSträng nullObligatoriskt: Adressrad.

Exempel: "example"
citySträng nullObligatoriskt: Stad eller ort.

Exempel: "example"
codeSträngObligatoriskt: Stabil maskinläsbar kod.

Exempel: "example"
country_codeSträngObligatoriskt: Landskod.

Exempel: "PL"
created_atSträngObligatoriskt: Tidpunkt för skapande.

format: "date-time"

Exempel: "2026-01-01T12:00:00Z"
customer_visibleBooleskt värdeObligatoriskt: Anger om statusen visas för kunden.

Exempel: false
idSträngObligatoriskt: Resursens identifierare; bevara den som den returneras. (WarehouseData).

Exempel: "example"
nameSträngObligatoriskt: Resursens namn i aktuell kontext.

Exempel: "Example"
postal_codeSträng nullObligatoriskt: Postnummer.

Exempel: "example"
updated_atSträngObligatoriskt: Tidpunkt för senaste uppdatering.

format: "date-time"

Exempel: "2026-01-01T12:00:00Z"
versionHeltalObligatoriskt: Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej