資料架構: 退貨、投訴與換貨

資料架構: 退貨、投訴與換貨. API 接收或傳回的資料欄位、類型和限制。

資料架構

取得清單 — 退貨、投訴與換貨 — 回應

ApiResponse_list_RequestSummaryData__ · API 接收或傳回的資料欄位、類型和限制。

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"}

附加欄位: 否

取得 — 退貨、投訴與換貨 — 回應

ApiResponse_RequestDetailData_ · API 接收或傳回的資料欄位、類型和限制。

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"}

附加欄位: 否

更新 · 退款金額 — 退貨、投訴與換貨 — 請求本文

RefundAmountUpdate · API 接收或傳回的資料欄位、類型和限制。

amount字串必填

以 JSON 字串編碼的十進位金額；僅在允許時使用 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

預設值: ""

附加欄位: 否

記錄的退款資訊

RefundData · 架構 · 資料架構: 退貨、投訴與換貨

amountMoneyData null必填

以 JSON 字串編碼的十進位金額；僅在允許時使用 null。

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

completed_at字串 null必填

完成時間。

字串:format: "date-time"

示例: null

status字串必填

此操作接受的狀態。

約束

enum: ["pending", "completed"]

示例: "pending"

updated_at字串 null必填

取得 — 退貨、投訴與換貨 — 回應

RequestDetailData · API 接收或傳回的資料欄位、類型和限制。

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

取得 — 退貨、投訴與換貨 — 回應

RequestItemData · API 接收或傳回的資料欄位、類型和限制。

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"}]

附加欄位: 否

此操作接受的狀態

RequestStatusData · 架構 · 資料架構: 退貨、投訴與換貨

id字串必填: 資源識別碼；請保留回傳的原值。 (RequestStatusData).

示例: "example"
locale字串必填: 本次請求選擇的語言。

示例: "en"
name字串 null必填: 對應上下文中的資源名稱。

示例: "Example"

附加欄位: 否

取得清單 · 狀態清單 — 退貨、投訴與換貨 — 回應

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · API 接收或傳回的資料欄位、類型和限制。

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"

附加欄位: 否

取得清單 · 狀態清單 — 退貨、投訴與換貨 — 回應

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · API 接收或傳回的資料欄位、類型和限制。

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"}

附加欄位: 否

更新 · 狀態 — 退貨、投訴與換貨 — 請求本文

RequestStatusUpdate · API 接收或傳回的資料欄位、類型和限制。

expected_version整數必填

寫入前讀取的版本；不匹配時拒絕更新。

minimum: 1maximum: 9223372036854775807

示例: 1

status_id字串必填

從相應狀態字典取得的識別碼。

約束

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

示例: "example"

附加欄位: 否

取得清單 — 退貨、投訴與換貨 — 回應

RequestSummaryData · API 接收或傳回的資料欄位、類型和限制。

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

資源類型

RequestType · 架構 · 資料架構: 退貨、投訴與換貨

字串

約束

enum: ["return", "exchange", "complaint"]

附加欄位: 是

與產品或快照關聯的變體選項

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · 架構 · 資料架構: 退貨、投訴與換貨

name字串必填: 對應上下文中的資源名稱。

示例: "Example"
value字串必填: 由所在架構描述的值。

示例: "example"

附加欄位: 否