確保した個体を一括で出荷する
最大100件、id重複不可。各行の価格省略は単体出荷と同じです。取り消し済みを含むと全件拒否し、新規の出荷は全件成功または全件取り消しです。 inventory:readに加え、この操作のスコープと許可したメンバーのinventory.write権限が必要です。
POST
/inventory/holds/ship-batch認証
AuthorizationOAuth2 アクセストークン · header必須認可コードフロー(PKCE S256 必須)。認可・トークン・更新のリクエストには resource=https://api.toreca-cloud.com/partner/v1 を付けます。アクセストークンは15分、リフレッシュトークンは90日有効で、更新のたびに入れ替わります。
スコープ:
inventory:readinventory:writeリクエストボディ
必須application/jsonholdsobject[]必須最小項目数 1 · 最大項目数 100
プロパティを表示プロパティを非表示
object の配列idstring<uuid>必須saleAmountMinorinteger最小 0 · 最大 10000000000
saleCurrencystring^[A-Z]{3}$ に一致
trackingNumberstring最小長 1 · 最大長 100
レスポンス
200
成功
holdsHold[]必須プロパティを表示プロパティを非表示
Hold の配列idstring<uuid>必須createdAtstring<date-time>必須updatedAtstring<date-time>必須orderNumberstring必須statusstring必須許可される値:
reservedawaiting_shipmentshippedcancelledversioninteger必須inventoryItemIdstring<uuid>必須purposestring必須許可される値:
oripasaledestinationLabelstring必須externalRefstring | null必須プロパティを表示プロパティを非表示
いずれか 1 つ:
string
stringnull
nullexpiresAtstring<date-time> | null必須プロパティを表示プロパティを非表示
いずれか 1 つ:
string<date-time>
string<date-time>null
nulltrackingNumberstring | null必須プロパティを表示プロパティを非表示
いずれか 1 つ:
string
stringnull
nullsaleobject | null必須プロパティを表示プロパティを非表示
いずれか 1 つ:
object
amountMinorinteger必須currencystring必須sourcestring必須許可される値:
enteredmarketnull
null400
invalid_request。パラメーターが正しくありません。
errorstring必須エラーのコード
scopestringinsufficient_scope のとき、足りない権限
requestIdstring<uuid>inventoryItemIdsstring<uuid>[]holdIdsstring<uuid>[]commitmentIdsstring<uuid>[]401
invalid_token。トークンがない、期限切れ、または別のリソース向けです。
errorstring必須エラーのコード
scopestringinsufficient_scope のとき、足りない権限
requestIdstring<uuid>inventoryItemIdsstring<uuid>[]holdIdsstring<uuid>[]commitmentIdsstring<uuid>[]403
insufficient_scope、connection_revoked、client_disabled、forbidden のいずれかです。
errorstring必須エラーのコード
scopestringinsufficient_scope のとき、足りない権限
requestIdstring<uuid>inventoryItemIdsstring<uuid>[]holdIdsstring<uuid>[]commitmentIdsstring<uuid>[]409
競合・requestIdの流用・受取未確認
errorstring必須エラーのコード
scopestringinsufficient_scope のとき、足りない権限
requestIdstring<uuid>inventoryItemIdsstring<uuid>[]holdIdsstring<uuid>[]commitmentIdsstring<uuid>[]422
現在の状態・対象・値では実行できません。errorと対象IDを確認します。
errorstring必須エラーのコード
scopestringinsufficient_scope のとき、足りない権限
requestIdstring<uuid>inventoryItemIdsstring<uuid>[]holdIdsstring<uuid>[]commitmentIdsstring<uuid>[]
