データスキーマ: 返品・苦情・交換

data配列 <RequestSummaryData > 必須

レスポンス例 · ApiResponse_list_RequestSummaryData__.

例: [{"created_at":"2026-01-01T12:00:00Z","customer":{"email":"customer@example.invalid","name":"Example"},"id":"example","number":"example","order_id":"example","order_number":"example","products_value":{"amount":"0.00","currency":"PLN","minor_units":2},"refund":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1},"resolution_state":"unknown","status":{"id":"example","locale":"en","name":"Example"},"type":"return","updated_at":"2026-01-01T12:00:00Z","version":1}]

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

レスポンスのメタデータ。

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

追加フィールド: いいえ

dataRequestDetailData 必須

レスポンス例 · RequestDetailData.

例: {"created_at":"2026-01-01T12:00:00Z","customer":{"email":"customer@example.invalid","name":"Example"},"id":"example","items":[{"id":"example","name":"Example","order_line_id":"example","product_id":"example","quantity":1,"returned_quantity":1,"sku":"example","total":{"amount":"0.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"0.00","currency":"PLN","minor_units":2},"variant_id":"example","variant_options":[{"name":"Example","value":"example"}]}],"number":"example","order_id":"example","order_number":"example","products_value":{"amount":"0.00","currency":"PLN","minor_units":2},"refund":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1},"resolution_state":"unknown","status":{"id":"example","locale":"en","name":"Example"},"type":"return","updated_at":"2026-01-01T12:00:00Z","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

レスポンスのメタデータ。

例: {"request_id":"example"}

追加フィールド: いいえ

amount文字列必須

JSON 文字列として表した10進数の金額。null は許可される場合のみ。

minLength: 1maxLength: 64

制約

pattern

"^[+-]?(?:[0-9]+(?:\\.[0-9]+)?|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?$"

例: "0.00"

expected_version整数必須

書き込み前に取得したバージョン。不一致の場合は更新を拒否します。

minimum: 0maximum: 9223372036854775807

例: 1

reason文字列任意

変更の記録理由。

maxLength: 500

既定値: ""

追加フィールド: いいえ

amountMoneyData | null必須

JSON 文字列として表した10進数の金額。null は許可される場合のみ。

例: {"amount":"0.00","currency":"PLN","minor_units":2}

completed_at文字列 | null必須

完了時刻。

文字列:format: "date-time"

例: null

status文字列必須

この操作で受け付けるステータス。

制約

enum

["pending", "completed"]

例: "pending"

updated_at文字列 | null必須

最終更新時刻。

文字列:format: "date-time"

例: "2026-01-01T12:00:00Z"

version整数必須

同時更新制御に使うリソースバージョン。

例: 1

追加フィールド: いいえ

created_at文字列必須

作成時刻。

format: "date-time"

例: "2026-01-01T12:00:00Z"

customerRequestCustomerData 必須

このリソースに記録された顧客情報。

例: {"email":"customer@example.invalid","name":"Example"}

id文字列必須

リソース識別子。返された値をそのまま保持してください。 (RequestDetailData).

例: "example"

items配列 <RequestItemData > 必須

リソースに含まれる項目。

例: [{"id":"example","name":"Example","order_line_id":"example","product_id":"example","quantity":1,"returned_quantity":1,"sku":"example","total":{"amount":"0.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"0.00","currency":"PLN","minor_units":2},"variant_id":"example","variant_options":[{"name":"Example","value":"example"}]}]

number文字列必須

人向けの注文番号または申請番号。

例: "example"

order_id文字列必須

関連する注文の識別子。

例: "example"

order_number文字列必須

関連する注文番号。

例: "example"

products_valueMoneyData 必須

注文内の商品の金額。

例: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData 必須

記録上の返金情報。

例: {"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1}

resolution_state文字列必須

顧客申請の解決状態。

制約

enum

["unknown", "open", "completed", "rejected", "cancelled"]

例: "unknown"

statusRequestStatusData 必須

この操作で受け付けるステータス。

例: {"id":"example","locale":"en","name":"Example"}

typeRequestType 必須

リソース種別。

例: "return"

updated_at文字列必須

最終更新時刻。

format: "date-time"

例: "2026-01-01T12:00:00Z"

version整数必須

同時更新制御に使うリソースバージョン。

例: 1

追加フィールド: いいえ

id文字列必須

リソース識別子。返された値をそのまま保持してください。 (RequestItemData).

例: "example"

name文字列必須

該当コンテキストでのリソース名。

例: "Example"

order_line_id文字列 | null必須

関連する注文明細の識別子。

例: "example"

product_id文字列必須

商品識別子。

例: "example"

quantity整数必須

数量。

例: 1

returned_quantity整数必須

この明細で返品された数量。

例: 1

sku文字列必須

在庫管理単位のコード。

例: "example"

totalMoneyData 必須

合計金額。

例: {"amount":"0.00","currency":"PLN","minor_units":2}

unit_priceMoneyData 必須

単価。

例: {"amount":"0.00","currency":"PLN","minor_units":2}

variant_id文字列 | null必須

商品バリエーション識別子。

例: "example"

variant_options配列 <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > 必須

商品またはスナップショットに関連するバリエーションオプション。

例: [{"name":"Example","value":"example"}]

追加フィールド: いいえ

id文字列必須

リソース識別子。返された値をそのまま保持してください。 (RequestStatusData).

例: "example"

locale文字列必須

このリクエストで選択した言語。

例: "en"

name文字列 | null必須

該当コンテキストでのリソース名。

例: "Example"

追加フィールド: いいえ

code文字列必須

安定した機械可読コード。

例: "example"

created_at文字列必須

作成時刻。

format: "date-time"

例: "2026-01-01T12:00:00Z"

id文字列必須

リソース識別子。返された値をそのまま保持してください。 (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

例: "example"

is_initial真偽値必須

初期ステータスかどうか。

例: false

locale文字列必須

このリクエストで選択した言語。

例: "en"

name文字列 | null必須

該当コンテキストでのリソース名。

例: "Example"

position整数必須

順序付きコレクション内の位置。

例: 1

typeRequestType 必須

リソース種別。

例: "return"

追加フィールド: いいえ

data配列 <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > 必須

レスポンス例 · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

例: [{"code":"example","created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"locale":"en","name":"Example","position":1,"type":"return"}]

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

レスポンスのメタデータ。

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

追加フィールド: いいえ

expected_version整数必須

書き込み前に取得したバージョン。不一致の場合は更新を拒否します。

minimum: 1maximum: 9223372036854775807

例: 1

status_id文字列必須

対応するステータス辞書から取得した識別子。

制約

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

例: "example"

追加フィールド: いいえ

created_at文字列必須

作成時刻。

format: "date-time"

例: "2026-01-01T12:00:00Z"

customerRequestCustomerData 必須

このリソースに記録された顧客情報。

例: {"email":"customer@example.invalid","name":"Example"}

id文字列必須

リソース識別子。返された値をそのまま保持してください。 (RequestSummaryData).

例: "example"

number文字列必須

人向けの注文番号または申請番号。

例: "example"

order_id文字列必須

関連する注文の識別子。

例: "example"

order_number文字列必須

関連する注文番号。

例: "example"

products_valueMoneyData 必須

注文内の商品の金額。

例: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData 必須

記録上の返金情報。

例: {"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1}

resolution_state文字列必須

顧客申請の解決状態。

制約

enum

["unknown", "open", "completed", "rejected", "cancelled"]

例: "unknown"

statusRequestStatusData 必須

この操作で受け付けるステータス。

例: {"id":"example","locale":"en","name":"Example"}

typeRequestType 必須

リソース種別。

例: "return"

updated_at文字列必須

最終更新時刻。

format: "date-time"

例: "2026-01-01T12:00:00Z"

version整数必須

同時更新制御に使うリソースバージョン。

例: 1

追加フィールド: いいえ

追加フィールド: はい

name文字列必須

該当コンテキストでのリソース名。

例: "Example"

value文字列必須

周囲のスキーマで説明される値。

例: "example"

追加フィールド: いいえ