数据架构: 退货、投诉与换货

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 字符串编码的十进制金额；仅在允许时使用 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 字符串编码的十进制金额；仅在允许时使用 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"

附加字段: 否