Dataskjemaer: Lagre og plasseringer

Dataskjemaer: Lagre og plasseringer. Felter, typer og begrensninger for data som API-et mottar eller returnerer.

Dataskjemaer

Vis liste · Plasseringer — Lagre og plasseringer — Svar

ApiResponse_list_LocationData__ · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

dataArray <LocationData > Obligatorisk: Eksempel på svar · ApiResponse_list_LocationData__.

Eksempel: [{"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 Obligatorisk: Svarmetadata.

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

Ytterligere felt: Nei

Vis liste — Lagre og plasseringer — Svar

ApiResponse_list_WarehouseData__ · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

dataArray <WarehouseData > Obligatorisk: Eksempel på svar · ApiResponse_list_WarehouseData__.

Eksempel: [{"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 Obligatorisk: Svarmetadata.

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

Ytterligere felt: Nei

Hent — Lagre og plasseringer — Svar

ApiResponse_WarehouseData_ · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

dataWarehouseData Obligatorisk: Eksempel på svar · WarehouseData.

Eksempel: {"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 Obligatorisk: Svarmetadata.

Eksempel: {"request_id":"example"}

Ytterligere felt: Nei

Vis liste · Plasseringer — Lagre og plasseringer — Svar

LocationData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

codeStrengObligatorisk

Stabil maskinlesbar kode.

Eksempel: "example"

created_atStrengObligatorisk

Opprettelsestidspunkt.

format: "date-time"

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

idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres. (LocationData).

Eksempel: "example"

is_leafBoolsk verdiObligatorisk

Om kategorien ikke har underkategorier.

Eksempel: true

location_typeStrengObligatorisk

Type lagerplassering.

Begrensninger

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

Eksempel: "zone"

nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

Eksempel: "Example"

parent_idStreng nullObligatorisk

Identifikator for overordnet kategori.

Eksempel: null

updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

format: "date-time"

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

versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

warehouse_idStrengObligatorisk

Lageridentifikator.

Eksempel: "example"

Ytterligere felt: Nei

Lagerplasseringer

LocationQuantity · Skjema · Dataskjemaer: Lagre og plasseringer

location_idStrengObligatorisk

Identifikator for lagerplassering.

Begrensninger

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

Eksempel: "example"

on_handHeltallObligatorisk

Fysisk lagermengde.

minimum: 0maximum: 2147483647

Eksempel: 1

Ytterligere felt: Nei

Hent — Lagre og plasseringer — Svar

WarehouseData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

activeBoolsk verdiObligatorisk: Om ressursen er aktiv.

Eksempel: true
address_lineStreng nullObligatorisk: Adresselinje.

Eksempel: "example"
cityStreng nullObligatorisk: By eller sted.

Eksempel: "example"
codeStrengObligatorisk: Stabil maskinlesbar kode.

Eksempel: "example"
country_codeStrengObligatorisk: Landskode.

Eksempel: "PL"
created_atStrengObligatorisk: Opprettelsestidspunkt.

format: "date-time"

Eksempel: "2026-01-01T12:00:00Z"
customer_visibleBoolsk verdiObligatorisk: Om statusen er synlig for kunden.

Eksempel: false
idStrengObligatorisk: Ressursidentifikator; behold den slik den returneres. (WarehouseData).

Eksempel: "example"
nameStrengObligatorisk: Ressursens navn i den relevante konteksten.

Eksempel: "Example"
postal_codeStreng nullObligatorisk: Postnummer.

Eksempel: "example"
updated_atStrengObligatorisk: Tidspunkt for siste oppdatering.

format: "date-time"

Eksempel: "2026-01-01T12:00:00Z"
versionHeltallObligatorisk: Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei