コンテンツにスキップ
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"

追加フィールド: いいえ