数据架构: 入库交付

数据架构: 入库交付. 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必填

获取 — 入库交付 — 响应

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必填