Pāriet uz saturu
ShopentlyLearn

Datu shēmas: Piegādes

Datu shēmas: Piegādes. API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

Datu shēmas

Iegūt — Piegādes — Atbilde

ApiResponse_DeliveryDetailData_ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
dataDeliveryDetailData Obligāts

Atbildes piemērs · DeliveryDetailData.

Piemērs: {"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 Obligāts

Atbildes metadati.

Piemērs: {"request_id":"example"}

Papildu lauki: Nē

Saraksts — Piegādes — Atbilde

ApiResponse_list_DeliveryData__ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
dataMasīvs <DeliveryData > Obligāts

Atbildes piemērs · ApiResponse_list_DeliveryData__.

Piemērs: [{"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 Obligāts

Atbildes metadati.

Piemērs: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Papildu lauki: Nē

Izveidot — Piegādes — Pieprasījuma saturs

DeliveryCreate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
delivered_atVirkneObligāts

Piegādes datums un laiks.

format: "date-time"
Piemērs: "2026-01-01T00:00:00Z"
increases_stockLoģiska vērtībaNeobligāts

Vai piegādes saņemšana palielina krājumus.

Noklusējums: true
location_idVirkneObligāts

Noliktavas atrašanās vietas identifikators.

Ierobežojumi
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Piemērs: "example"
notesVirkneNeobligāts

Papildu piezīmes.

maxLength: 2000
Noklusējums: ""
quantityVesels skaitlisObligāts

Vienību skaits.

minimum: 1maximum: 2147483647
Piemērs: 1
reasonVirkneNeobligāts

Reģistrētais izmaiņas iemesls.

maxLength: 500
Noklusējums: ""
statusVirkneObligāts

Šai konkrētajai darbībai pieņemamais statuss.

Ierobežojumi
enum
["planned", "received"]
Piemērs: "planned"
target_idVirkneObligāts

Darbības ietekmētā produkta vai varianta identifikators.

Ierobežojumi
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Piemērs: "example"
target_typeVirkneObligāts

Vai darbība attiecas uz produktu vai variantu.

Ierobežojumi
enum
["product", "variant"]
Piemērs: "product"
warehouse_idVirkneObligāts

Noliktavas identifikators.

Ierobežojumi
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Piemērs: "example"

Papildu lauki: Nē

Saraksts — Piegādes — Atbilde

DeliveryData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
created_atVirkneObligāts

Izveides laiks.

format: "date-time"
Piemērs: "2026-01-01T12:00:00Z"
deleted_atVirkne nullObligāts

Dzēšanas laiks, ja norādīts.

Virkne:format: "date-time"
Piemērs: null
delivered_atVirkneObligāts

Piegādes datums un laiks.

format: "date-time"
Piemērs: "2026-01-01T12:00:00Z"
idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (DeliveryData).

Piemērs: "example"
increases_stockLoģiska vērtībaObligāts

Vai piegādes saņemšana palielina krājumus.

Piemērs: true
location_idVirkneObligāts

Noliktavas atrašanās vietas identifikators.

Piemērs: "example"
quantityVesels skaitlisObligāts

Vienību skaits.

Piemērs: 1
received_atVirkne nullObligāts

Piegādes saņemšanas datums un laiks.

Virkne:format: "date-time"
Piemērs: null
record_statusVirkneObligāts

Saglabātā ieraksta statuss.

Ierobežojumi
enum
["active", "deleted"]
Piemērs: "active"
statusVirkneObligāts

Šai konkrētajai darbībai pieņemamais statuss.

Ierobežojumi
enum
["planned", "received"]
Piemērs: "planned"
stock_applied_atVirkne nullObligāts

Datums un laiks, kad piemērota piegādes krājumu izmaiņa.

Virkne:format: "date-time"
Piemērs: null
target_idVirkneObligāts

Darbības ietekmētā produkta vai varianta identifikators.

Piemērs: "example"
target_typeVirkneObligāts

Vai darbība attiecas uz produktu vai variantu.

Ierobežojumi
enum
["product", "variant"]
Piemērs: "product"
updated_atVirkne nullObligāts

Pēdējās atjaunināšanas laiks.

Virkne:format: "date-time"
Piemērs: "2026-01-01T12:00:00Z"
versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1
warehouse_idVirkneObligāts

Noliktavas identifikators.

Piemērs: "example"

Papildu lauki: Nē

Iegūt — Piegādes — Atbilde

DeliveryDetailData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
created_atVirkneObligāts

Izveides laiks.

format: "date-time"
Piemērs: "2026-01-01T12:00:00Z"
deleted_atVirkne nullObligāts

Dzēšanas laiks, ja norādīts.

Virkne:format: "date-time"
Piemērs: null
delivered_atVirkneObligāts

Piegādes datums un laiks.

format: "date-time"
Piemērs: "2026-01-01T12:00:00Z"
idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (DeliveryDetailData).

Piemērs: "example"
increases_stockLoģiska vērtībaObligāts

Vai piegādes saņemšana palielina krājumus.

Piemērs: true
location_idVirkneObligāts

Noliktavas atrašanās vietas identifikators.

Piemērs: "example"
notesVirkne nullObligāts

Papildu piezīmes.

Piemērs: "example"
quantityVesels skaitlisObligāts

Vienību skaits.

Piemērs: 1
received_atVirkne nullObligāts

Piegādes saņemšanas datums un laiks.

Virkne:format: "date-time"
Piemērs: null
record_statusVirkneObligāts

Saglabātā ieraksta statuss.

Ierobežojumi
enum
["active", "deleted"]
Piemērs: "active"
statusVirkneObligāts

Šai konkrētajai darbībai pieņemamais statuss.

Ierobežojumi
enum
["planned", "received"]
Piemērs: "planned"
stock_applied_atVirkne nullObligāts

Datums un laiks, kad piemērota piegādes krājumu izmaiņa.

Virkne:format: "date-time"
Piemērs: null
target_idVirkneObligāts

Darbības ietekmētā produkta vai varianta identifikators.

Piemērs: "example"
target_typeVirkneObligāts

Vai darbība attiecas uz produktu vai variantu.

Ierobežojumi
enum
["product", "variant"]
Piemērs: "product"
updated_atVirkne nullObligāts

Pēdējās atjaunināšanas laiks.

Virkne:format: "date-time"
Piemērs: "2026-01-01T12:00:00Z"
versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1
warehouse_idVirkneObligāts

Noliktavas identifikators.

Piemērs: "example"

Papildu lauki: Nē