Gå til indhold
ShopentlyLearn

Dataskemaer: Leverancer

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

Dataskemaer

Hent — Leverancer — Svar

ApiResponse_DeliveryDetailData_ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
dataDeliveryDetailData Obligatorisk

Eksempel på svar · DeliveryDetailData.

Eksempel: {"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","notes":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorisk

Svarmetadata.

Eksempel: {"request_id":"example"}

Yderligere felter: Nej

Vis liste — Leverancer — Svar

ApiResponse_list_DeliveryData__ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
dataArray <DeliveryData > Obligatorisk

Eksempel på svar · ApiResponse_list_DeliveryData__.

Eksempel: [{"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","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

Opret — Leverancer — Forespørgselsindhold

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

Leveringsdato og -tidspunkt.

format: "date-time"
Eksempel: "2026-01-01T00:00:00Z"
increases_stockBoolesk værdiValgfrit

Om modtagelse af leverancen øger lagerbeholdningen.

Standard: true
location_idStrengObligatorisk

Identifikator for lagerplacering.

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

Yderligere bemærkninger.

maxLength: 2000
Standard: ""
quantityHeltalObligatorisk

Antal enheder.

minimum: 1maximum: 2147483647
Eksempel: 1
reasonStrengValgfrit

Registreret begrundelse for ændringen.

maxLength: 500
Standard: ""
statusStrengObligatorisk

Status accepteret af denne specifikke operation.

Begrænsninger
enum
["planned", "received"]
Eksempel: "planned"
target_idStrengObligatorisk

Identifikator for produktet eller varianten, som operationen påvirker.

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

Om operationen vedrører et produkt eller en variant.

Begrænsninger
enum
["product", "variant"]
Eksempel: "product"
warehouse_idStrengObligatorisk

Lageridentifikator.

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

Yderligere felter: Nej

Vis liste — Leverancer — Svar

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

Oprettelsestidspunkt.

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

Sletningstidspunkt, hvis det findes.

Streng:format: "date-time"
Eksempel: null
delivered_atStrengObligatorisk

Leveringsdato og -tidspunkt.

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

Ressourceidentifikator; bevar den som returneret. (DeliveryData).

Eksempel: "example"
increases_stockBoolesk værdiObligatorisk

Om modtagelse af leverancen øger lagerbeholdningen.

Eksempel: true
location_idStrengObligatorisk

Identifikator for lagerplacering.

Eksempel: "example"
quantityHeltalObligatorisk

Antal enheder.

Eksempel: 1
received_atStreng nullObligatorisk

Dato og tidspunkt for modtagelse af leverancen.

Streng:format: "date-time"
Eksempel: null
record_statusStrengObligatorisk

Gemt poststatus.

Begrænsninger
enum
["active", "deleted"]
Eksempel: "active"
statusStrengObligatorisk

Status accepteret af denne specifikke operation.

Begrænsninger
enum
["planned", "received"]
Eksempel: "planned"
stock_applied_atStreng nullObligatorisk

Dato og tidspunkt, hvor leverancens lagerændring blev anvendt.

Streng:format: "date-time"
Eksempel: null
target_idStrengObligatorisk

Identifikator for produktet eller varianten, som operationen påvirker.

Eksempel: "example"
target_typeStrengObligatorisk

Om operationen vedrører et produkt eller en variant.

Begrænsninger
enum
["product", "variant"]
Eksempel: "product"
updated_atStreng nullObligatorisk

Tidspunkt for seneste opdatering.

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

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1
warehouse_idStrengObligatorisk

Lageridentifikator.

Eksempel: "example"

Yderligere felter: Nej

Hent — Leverancer — Svar

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

Oprettelsestidspunkt.

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

Sletningstidspunkt, hvis det findes.

Streng:format: "date-time"
Eksempel: null
delivered_atStrengObligatorisk

Leveringsdato og -tidspunkt.

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

Ressourceidentifikator; bevar den som returneret. (DeliveryDetailData).

Eksempel: "example"
increases_stockBoolesk værdiObligatorisk

Om modtagelse af leverancen øger lagerbeholdningen.

Eksempel: true
location_idStrengObligatorisk

Identifikator for lagerplacering.

Eksempel: "example"
notesStreng nullObligatorisk

Yderligere bemærkninger.

Eksempel: "example"
quantityHeltalObligatorisk

Antal enheder.

Eksempel: 1
received_atStreng nullObligatorisk

Dato og tidspunkt for modtagelse af leverancen.

Streng:format: "date-time"
Eksempel: null
record_statusStrengObligatorisk

Gemt poststatus.

Begrænsninger
enum
["active", "deleted"]
Eksempel: "active"
statusStrengObligatorisk

Status accepteret af denne specifikke operation.

Begrænsninger
enum
["planned", "received"]
Eksempel: "planned"
stock_applied_atStreng nullObligatorisk

Dato og tidspunkt, hvor leverancens lagerændring blev anvendt.

Streng:format: "date-time"
Eksempel: null
target_idStrengObligatorisk

Identifikator for produktet eller varianten, som operationen påvirker.

Eksempel: "example"
target_typeStrengObligatorisk

Om operationen vedrører et produkt eller en variant.

Begrænsninger
enum
["product", "variant"]
Eksempel: "product"
updated_atStreng nullObligatorisk

Tidspunkt for seneste opdatering.

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

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1
warehouse_idStrengObligatorisk

Lageridentifikator.

Eksempel: "example"

Yderligere felter: Nej