跳至內容
ShopentlyLearn

資料架構: 入庫交付

資料架構: 入庫交付. API 接收或傳回的資料欄位、類型和限制。

資料架構

取得 — 入庫交付 — 回應

ApiResponse_DeliveryDetailData_ · API 接收或傳回的資料欄位、類型和限制。
dataDeliveryDetailData 必填

回應示例 · DeliveryDetailData.

示例: {"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 必填

回應元資料。

示例: {"request_id":"example"}

附加欄位: 否

取得清單 — 入庫交付 — 回應

ApiResponse_list_DeliveryData__ · API 接收或傳回的資料欄位、類型和限制。
data陣列 <DeliveryData > 必填

回應示例 · ApiResponse_list_DeliveryData__.

示例: [{"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 必填

回應元資料。

示例: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

附加欄位: 否

建立 — 入庫交付 — 請求本文

DeliveryCreate · API 接收或傳回的資料欄位、類型和限制。
delivered_at字串必填

交付日期和時間。

format: "date-time"
示例: "2026-01-01T00:00:00Z"
increases_stock布林值選填

接收交付是否增加庫存。

預設值: true
location_id字串必填

倉庫庫位識別碼。

約束
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
示例: "example"
notes字串選填

附加備註。

maxLength: 2000
預設值: ""
quantity整數必填

單位數量。

minimum: 1maximum: 2147483647
示例: 1
reason字串選填

記錄的變更原因。

maxLength: 500
預設值: ""
status字串必填

此操作接受的狀態。

約束
enum
["planned", "received"]
示例: "planned"
target_id字串必填

操作影響的產品或變體識別碼。

約束
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
示例: "example"
target_type字串必填

操作針對產品還是變體。

約束
enum
["product", "variant"]
示例: "product"
warehouse_id字串必填

倉庫識別碼。

約束
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
示例: "example"

附加欄位: 否

取得清單 — 入庫交付 — 回應

DeliveryData · API 接收或傳回的資料欄位、類型和限制。
created_at字串必填

建立時間。

format: "date-time"
示例: "2026-01-01T12:00:00Z"
deleted_at字串 null必填

刪除時間(如存在)。

字串:format: "date-time"
示例: null
delivered_at字串必填

交付日期和時間。

format: "date-time"
示例: "2026-01-01T12:00:00Z"
id字串必填

資源識別碼;請保留回傳的原值。 (DeliveryData).

示例: "example"
increases_stock布林值必填

接收交付是否增加庫存。

示例: true
location_id字串必填

倉庫庫位識別碼。

示例: "example"
quantity整數必填

單位數量。

示例: 1
received_at字串 null必填

接收交付的日期和時間。

字串:format: "date-time"
示例: null
record_status字串必填

保存的記錄狀態。

約束
enum
["active", "deleted"]
示例: "active"
status字串必填

此操作接受的狀態。

約束
enum
["planned", "received"]
示例: "planned"
stock_applied_at字串 null必填

交付導致的庫存變動實際應用的日期和時間。

字串:format: "date-time"
示例: null
target_id字串必填

操作影響的產品或變體識別碼。

示例: "example"
target_type字串必填

操作針對產品還是變體。

約束
enum
["product", "variant"]
示例: "product"
updated_at字串 null必填

最近更新時間。

字串:format: "date-time"
示例: "2026-01-01T12:00:00Z"
version整數必填

用於並行控制的資源版本。

示例: 1
warehouse_id字串必填

倉庫識別碼。

示例: "example"

附加欄位: 否

取得 — 入庫交付 — 回應

DeliveryDetailData · API 接收或傳回的資料欄位、類型和限制。
created_at字串必填

建立時間。

format: "date-time"
示例: "2026-01-01T12:00:00Z"
deleted_at字串 null必填

刪除時間(如存在)。

字串:format: "date-time"
示例: null
delivered_at字串必填

交付日期和時間。

format: "date-time"
示例: "2026-01-01T12:00:00Z"
id字串必填

資源識別碼;請保留回傳的原值。 (DeliveryDetailData).

示例: "example"
increases_stock布林值必填

接收交付是否增加庫存。

示例: true
location_id字串必填

倉庫庫位識別碼。

示例: "example"
notes字串 null必填

附加備註。

示例: "example"
quantity整數必填

單位數量。

示例: 1
received_at字串 null必填

接收交付的日期和時間。

字串:format: "date-time"
示例: null
record_status字串必填

保存的記錄狀態。

約束
enum
["active", "deleted"]
示例: "active"
status字串必填

此操作接受的狀態。

約束
enum
["planned", "received"]
示例: "planned"
stock_applied_at字串 null必填

交付導致的庫存變動實際應用的日期和時間。

字串:format: "date-time"
示例: null
target_id字串必填

操作影響的產品或變體識別碼。

示例: "example"
target_type字串必填

操作針對產品還是變體。

約束
enum
["product", "variant"]
示例: "product"
updated_at字串 null必填

最近更新時間。

字串:format: "date-time"
示例: "2026-01-01T12:00:00Z"
version整數必填

用於並行控制的資源版本。

示例: 1
warehouse_id字串必填

倉庫識別碼。

示例: "example"

附加欄位: 否