Přejít na obsah
ShopentlyLearn

Datová schémata: Dodávky

Datová schémata: Dodávky. Pole, typy a omezení dat přijímaných nebo vracených API.

Datová schémata

Načíst — Dodávky — Odpověď

ApiResponse_DeliveryDetailData_ · Pole, typy a omezení dat přijímaných nebo vracených API.
dataDeliveryDetailData Povinné

Příklad odpovědi · DeliveryDetailData.

Příklad: {"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 Povinné

Metadata odpovědi.

Příklad: {"request_id":"example"}

Další pole: Ne

Vypsat — Dodávky — Odpověď

ApiResponse_list_DeliveryData__ · Pole, typy a omezení dat přijímaných nebo vracených API.
dataPole <DeliveryData > Povinné

Příklad odpovědi · ApiResponse_list_DeliveryData__.

Příklad: [{"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 Povinné

Metadata odpovědi.

Příklad: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Další pole: Ne

Vytvořit — Dodávky — Tělo požadavku

DeliveryCreate · Pole, typy a omezení dat přijímaných nebo vracených API.
delivered_atŘetězecPovinné

Datum a čas dodání.

format: "date-time"
Příklad: "2026-01-01T00:00:00Z"
increases_stockLogická hodnotaVolitelné

Zda přijetí dodávky zvýší zásoby.

Výchozí hodnota: true
location_idŘetězecPovinné

Identifikátor skladového umístění.

Omezení
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Příklad: "example"
notesŘetězecVolitelné

Doplňující poznámky.

maxLength: 2000
Výchozí hodnota: ""
quantityCelé čísloPovinné

Počet jednotek.

minimum: 1maximum: 2147483647
Příklad: 1
reasonŘetězecVolitelné

Důvod zaznamenaný u změny.

maxLength: 500
Výchozí hodnota: ""
statusŘetězecPovinné

Stav přijímaný touto konkrétní operací.

Omezení
enum
["planned", "received"]
Příklad: "planned"
target_idŘetězecPovinné

Identifikátor produktu nebo varianty, které se operace týká.

Omezení
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Příklad: "example"
target_typeŘetězecPovinné

Zda se operace týká produktu, nebo varianty.

Omezení
enum
["product", "variant"]
Příklad: "product"
warehouse_idŘetězecPovinné

Identifikátor skladu.

Omezení
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Příklad: "example"

Další pole: Ne

Vypsat — Dodávky — Odpověď

DeliveryData · Pole, typy a omezení dat přijímaných nebo vracených API.
created_atŘetězecPovinné

Čas vytvoření.

format: "date-time"
Příklad: "2026-01-01T12:00:00Z"
deleted_atŘetězec nullPovinné

Čas smazání, pokud existuje.

Řetězec:format: "date-time"
Příklad: null
delivered_atŘetězecPovinné

Datum a čas dodání.

format: "date-time"
Příklad: "2026-01-01T12:00:00Z"
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (DeliveryData).

Příklad: "example"
increases_stockLogická hodnotaPovinné

Zda přijetí dodávky zvýší zásoby.

Příklad: true
location_idŘetězecPovinné

Identifikátor skladového umístění.

Příklad: "example"
quantityCelé čísloPovinné

Počet jednotek.

Příklad: 1
received_atŘetězec nullPovinné

Datum a čas přijetí dodávky.

Řetězec:format: "date-time"
Příklad: null
record_statusŘetězecPovinné

Uložený stav záznamu.

Omezení
enum
["active", "deleted"]
Příklad: "active"
statusŘetězecPovinné

Stav přijímaný touto konkrétní operací.

Omezení
enum
["planned", "received"]
Příklad: "planned"
stock_applied_atŘetězec nullPovinné

Datum a čas provedení změny zásob z této dodávky.

Řetězec:format: "date-time"
Příklad: null
target_idŘetězecPovinné

Identifikátor produktu nebo varianty, které se operace týká.

Příklad: "example"
target_typeŘetězecPovinné

Zda se operace týká produktu, nebo varianty.

Omezení
enum
["product", "variant"]
Příklad: "product"
updated_atŘetězec nullPovinné

Čas poslední aktualizace.

Řetězec:format: "date-time"
Příklad: "2026-01-01T12:00:00Z"
versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1
warehouse_idŘetězecPovinné

Identifikátor skladu.

Příklad: "example"

Další pole: Ne

Načíst — Dodávky — Odpověď

DeliveryDetailData · Pole, typy a omezení dat přijímaných nebo vracených API.
created_atŘetězecPovinné

Čas vytvoření.

format: "date-time"
Příklad: "2026-01-01T12:00:00Z"
deleted_atŘetězec nullPovinné

Čas smazání, pokud existuje.

Řetězec:format: "date-time"
Příklad: null
delivered_atŘetězecPovinné

Datum a čas dodání.

format: "date-time"
Příklad: "2026-01-01T12:00:00Z"
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (DeliveryDetailData).

Příklad: "example"
increases_stockLogická hodnotaPovinné

Zda přijetí dodávky zvýší zásoby.

Příklad: true
location_idŘetězecPovinné

Identifikátor skladového umístění.

Příklad: "example"
notesŘetězec nullPovinné

Doplňující poznámky.

Příklad: "example"
quantityCelé čísloPovinné

Počet jednotek.

Příklad: 1
received_atŘetězec nullPovinné

Datum a čas přijetí dodávky.

Řetězec:format: "date-time"
Příklad: null
record_statusŘetězecPovinné

Uložený stav záznamu.

Omezení
enum
["active", "deleted"]
Příklad: "active"
statusŘetězecPovinné

Stav přijímaný touto konkrétní operací.

Omezení
enum
["planned", "received"]
Příklad: "planned"
stock_applied_atŘetězec nullPovinné

Datum a čas provedení změny zásob z této dodávky.

Řetězec:format: "date-time"
Příklad: null
target_idŘetězecPovinné

Identifikátor produktu nebo varianty, které se operace týká.

Příklad: "example"
target_typeŘetězecPovinné

Zda se operace týká produktu, nebo varianty.

Omezení
enum
["product", "variant"]
Příklad: "product"
updated_atŘetězec nullPovinné

Čas poslední aktualizace.

Řetězec:format: "date-time"
Příklad: "2026-01-01T12:00:00Z"
versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1
warehouse_idŘetězecPovinné

Identifikátor skladu.

Příklad: "example"

Další pole: Ne