Gegevensschema’s: Magazijnen en locaties

Gegevensschema’s: Magazijnen en locaties. Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

Gegevensschema’s

Lijst ophalen · Locaties — Magazijnen en locaties — Antwoord

ApiResponse_list_LocationData__ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataArray <LocationData > Verplicht: Voorbeeldantwoord · ApiResponse_list_LocationData__.

Voorbeeld: [{"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 Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Lijst ophalen — Magazijnen en locaties — Antwoord

ApiResponse_list_WarehouseData__ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataArray <WarehouseData > Verplicht: Voorbeeldantwoord · ApiResponse_list_WarehouseData__.

Voorbeeld: [{"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 Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Ophalen — Magazijnen en locaties — Antwoord

ApiResponse_WarehouseData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataWarehouseData Verplicht: Voorbeeldantwoord · WarehouseData.

Voorbeeld: {"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 Verplicht: Metadata van het antwoord.

Voorbeeld: {"request_id":"example"}

Aanvullende velden: Nee

Lijst ophalen · Locaties — Magazijnen en locaties — Antwoord

LocationData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

codeTekenreeksVerplicht

Stabiele, machineleesbare code.

Voorbeeld: "example"

created_atTekenreeksVerplicht

Tijdstip van aanmaak.

format: "date-time"

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

idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. (LocationData).

Voorbeeld: "example"

is_leafBooleaanse waardeVerplicht

Of de categorie geen subcategorieën heeft.

Voorbeeld: true

location_typeTekenreeksVerplicht

Type magazijnlocatie.

Beperkingen

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

Voorbeeld: "zone"

nameTekenreeksVerplicht

Resourcenaam in de betreffende context.

Voorbeeld: "Example"

parent_idTekenreeks nullVerplicht

Identificatie van de bovenliggende categorie.

Voorbeeld: null

updated_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"

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

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

warehouse_idTekenreeksVerplicht

Magazijnidentificatie.

Voorbeeld: "example"

Aanvullende velden: Nee

Magazijnlocaties

LocationQuantity · Schema · Gegevensschema’s: Magazijnen en locaties

location_idTekenreeksVerplicht

Identificatie van de magazijnlocatie.

Beperkingen

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

Voorbeeld: "example"

on_handGeheel getalVerplicht

Fysiek aanwezige voorraad.

minimum: 0maximum: 2147483647

Voorbeeld: 1

Aanvullende velden: Nee

Ophalen — Magazijnen en locaties — Antwoord

WarehouseData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

activeBooleaanse waardeVerplicht: Of de resource actief is.

Voorbeeld: true
address_lineTekenreeks nullVerplicht: Adresregel.

Voorbeeld: "example"
cityTekenreeks nullVerplicht: Stad of plaats.

Voorbeeld: "example"
codeTekenreeksVerplicht: Stabiele, machineleesbare code.

Voorbeeld: "example"
country_codeTekenreeksVerplicht: Landcode.

Voorbeeld: "PL"
created_atTekenreeksVerplicht: Tijdstip van aanmaak.

format: "date-time"

Voorbeeld: "2026-01-01T12:00:00Z"
customer_visibleBooleaanse waardeVerplicht: Of de status zichtbaar is voor de klant.

Voorbeeld: false
idTekenreeksVerplicht: Resource-identificatie; bewaar deze zoals teruggegeven. (WarehouseData).

Voorbeeld: "example"
nameTekenreeksVerplicht: Resourcenaam in de betreffende context.

Voorbeeld: "Example"
postal_codeTekenreeks nullVerplicht: Postcode.

Voorbeeld: "example"
updated_atTekenreeksVerplicht: Tijdstip van de meest recente wijziging.

format: "date-time"

Voorbeeld: "2026-01-01T12:00:00Z"
versionGeheel getalVerplicht: Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee