Gå til indhold
ShopentlyLearn

Dataskemaer: Lagre og placeringer

Dataskemaer: Lagre og placeringer. Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

Dataskemaer

Vis liste · Placeringer — Lagre og placeringer — Svar

ApiResponse_list_LocationData__ · Felter, typer og begrænsninger for data, som API'et modtager 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"}

Yderligere felter: Nej

Vis liste — Lagre og placeringer — Svar

ApiResponse_list_WarehouseData__ · Felter, typer og begrænsninger for data, som API'et modtager 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"}

Yderligere felter: Nej

Hent — Lagre og placeringer — Svar

ApiResponse_WarehouseData_ · Felter, typer og begrænsninger for data, som API'et modtager 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"}

Yderligere felter: Nej

Vis liste · Placeringer — Lagre og placeringer — Svar

LocationData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
codeStrengObligatorisk

Stabil maskinlæsbar kode.

Eksempel: "example"
created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (LocationData).

Eksempel: "example"
is_leafBoolesk værdiObligatorisk

Om kategorien ikke har underkategorier.

Eksempel: true
location_typeStrengObligatorisk

Type af lagerplacering.

Begrænsninger
enum
["zone", "rack", "shelf", "bin"]
Eksempel: "zone"
nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Example"
parent_idStreng nullObligatorisk

Identifikator for overordnet kategori.

Eksempel: null
updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1
warehouse_idStrengObligatorisk

Lageridentifikator.

Eksempel: "example"

Yderligere felter: Nej

Lagerplaceringer

LocationQuantity · Skema · Dataskemaer: Lagre og placeringer
location_idStrengObligatorisk

Identifikator for lagerplacering.

Begrænsninger
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Eksempel: "example"
on_handHeltalObligatorisk

Fysisk lagermængde.

minimum: 0maximum: 2147483647
Eksempel: 1

Yderligere felter: Nej

Hent — Lagre og placeringer — Svar

WarehouseData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
activeBoolesk værdiObligatorisk

Om ressourcen er aktiv.

Eksempel: true
address_lineStreng nullObligatorisk

Adresselinje.

Eksempel: "example"
cityStreng nullObligatorisk

By eller lokalitet.

Eksempel: "example"
codeStrengObligatorisk

Stabil maskinlæsbar kode.

Eksempel: "example"
country_codeStrengObligatorisk

Landekode.

Eksempel: "PL"
created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
customer_visibleBoolesk værdiObligatorisk

Om status er synlig for kunden.

Eksempel: false
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (WarehouseData).

Eksempel: "example"
nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Example"
postal_codeStreng nullObligatorisk

Postnummer.

Eksempel: "example"
updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej