Andmeskeemid: Laod ja asukohad

Andmeskeemid: Laod ja asukohad. API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

Andmeskeemid

Loend · Asukohad — Laod ja asukohad — Vastus

ApiResponse_list_LocationData__ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataMassiiv <LocationData > Kohustuslik: Vastuse näide · ApiResponse_list_LocationData__.

Näide: [{"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 Kohustuslik: Vastuse metaandmed.

Näide: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Lisaväljad: Ei

Loend — Laod ja asukohad — Vastus

ApiResponse_list_WarehouseData__ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataMassiiv <WarehouseData > Kohustuslik: Vastuse näide · ApiResponse_list_WarehouseData__.

Näide: [{"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 Kohustuslik: Vastuse metaandmed.

Näide: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Lisaväljad: Ei

Hangi — Laod ja asukohad — Vastus

ApiResponse_WarehouseData_ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataWarehouseData Kohustuslik: Vastuse näide · WarehouseData.

Näide: {"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 Kohustuslik: Vastuse metaandmed.

Näide: {"request_id":"example"}

Lisaväljad: Ei

Loend · Asukohad — Laod ja asukohad — Vastus

LocationData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

codeStringKohustuslik

Püsiv masinloetav kood.

Näide: "example"

created_atStringKohustuslik

Loomise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. (LocationData).

Näide: "example"

is_leafTõeväärtusKohustuslik

Kas kategoorial puuduvad alamkategooriad.

Näide: true

location_typeStringKohustuslik

Laoasukoha tüüp.

Piirangud

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

Näide: "zone"

nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

Näide: "Example"

parent_idString nullKohustuslik

Vanemkategooria identifikaator.

Näide: null

updated_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

warehouse_idStringKohustuslik

Lao identifikaator.

Näide: "example"

Lisaväljad: Ei

Laoasukohtade loend

LocationQuantity · Skeem · Andmeskeemid: Laod ja asukohad

location_idStringKohustuslik

Laoasukoha identifikaator.

Piirangud

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

Näide: "example"

on_handTäisarvKohustuslik

Füüsiline laokogus.

minimum: 0maximum: 2147483647

Näide: 1

Lisaväljad: Ei

Hangi — Laod ja asukohad — Vastus

WarehouseData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

activeTõeväärtusKohustuslik: Kas ressurss on aktiivne.

Näide: true
address_lineString nullKohustuslik: Aadressirida.

Näide: "example"
cityString nullKohustuslik: Linn või asula.

Näide: "example"
codeStringKohustuslik: Püsiv masinloetav kood.

Näide: "example"
country_codeStringKohustuslik: Riigikood.

Näide: "PL"
created_atStringKohustuslik: Loomise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"
customer_visibleTõeväärtusKohustuslik: Kas olek on kliendile nähtav.

Näide: false
idStringKohustuslik: Ressursi identifikaator; säilita see tagastatud kujul. (WarehouseData).

Näide: "example"
nameStringKohustuslik: Ressursi nimi vastavas kontekstis.

Näide: "Example"
postal_codeString nullKohustuslik: Postiindeks.

Näide: "example"
updated_atStringKohustuslik: Viimase uuendamise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"
versionTäisarvKohustuslik: Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

Lisaväljad: Ei