数据架构: 订单

address_line_1字符串 | null必填

第一行地址。

address_line_2字符串 | null必填

附加地址信息。

city字符串 | null必填

城市或地方。

country_code字符串 | null必填

国家代码。

first_name字符串 | null必填

名。

house_number字符串 | null必填

楼号或门牌号。

last_name字符串 | null必填

姓。

phone字符串 | null必填

电话号码。

postal_code字符串 | null必填

邮政编码。

region字符串 | null必填

行政区域。

street字符串 | null必填

街道名称。

附加字段: 否

dataOrderFileListData 必填

成功响应的数据。

示例: {"files":[{"can_download":true,"category":"digital","filename":"manual.pdf","id":"example","label":"Manual","line_id":"example","mime_type":"application/pdf","product_id":"example","purchase_id":"00000000-0000-4000-8000-000000000001","reason":"paid","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"source_file_id":"00000000-0000-4000-8000-000000000001","source_version_id":"00000000-0000-4000-8000-000000000001","source_version_number":1,"state":"active"}],"updates_pending":false}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必填

响应元数据。

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

附加字段: 否

dataOrderReleaseListData 必填

成功响应的数据。

示例: {"releases":[{"access_reason":"paid","access_state":"active","current_release":null,"grant_reason":"purchase","granted_at":"2026-01-01T12:00:00Z","id":"example","line_id":"example","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","product_id":"example","published_at":"2026-01-01T12:00:00Z","purchase_id":"00000000-0000-4000-8000-000000000001","release_id":"00000000-0000-4000-8000-000000000001","release_sequence":1,"update_days":365,"update_mode":"period","update_months":null,"updates_until":"2027-01-01T12:00:00Z","version_label":"1.0"}],"updates_pending":false}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必填

响应元数据。

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

附加字段: 否

data数组 <OrderSummaryData > 必填

响应示例 · ApiResponse_list_OrderSummaryData__.

示例: [{"created_at":"2026-10-19T10:00:00Z","customer":{"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null},"delivery":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"dates":{"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"},"method_code":"shipping-old","method_name":"Historic carrier","pickup_point":null,"recipient_mode":"full_address"},"discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"id":"order-0000","lifecycle_state":"placed","locale":"pl","market_id":"market-pl","number":"0001","payment":{"amount":{"amount":"329.40","currency":"PLN","minor_units":2},"environment":"live","method_code":"payment-old","method_name":"Historic method","paid_at":null,"status":"unpaid","updated_at":"2026-10-19T10:00:00Z","version":0},"prices_include_tax":true,"shipping_discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"status":{"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1},"subtotal":{"amount":"329.40","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2},"tax_country_code":"PL","total":{"amount":"329.40","currency":"PLN","minor_units":2}}]

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必填

响应元数据。

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

附加字段: 否

dataOrderDetailData 必填

响应示例 · OrderDetailData.

示例: {"created_at":"2026-10-19T10:00:00Z","customer":{"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null},"delivery":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"dates":{"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"},"discount_gross":{"amount":"24.60","currency":"PLN","minor_units":2},"discount_net":{"amount":"20.00","currency":"PLN","minor_units":2},"discount_tax":{"amount":"4.60","currency":"PLN","minor_units":2},"discounts":[{"amount":{"amount":"24.60","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"version":3}],"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"method_code":"shipping-old","method_name":"Historic carrier","net":{"amount":"0.00","currency":"PLN","minor_units":2},"original_gross":{"amount":"24.60","currency":"PLN","minor_units":2},"original_net":{"amount":"20.00","currency":"PLN","minor_units":2},"original_tax":{"amount":"4.60","currency":"PLN","minor_units":2},"pickup_point":null,"recipient_mode":"full_address","tax":{"amount":"0.00","currency":"PLN","minor_units":2},"tax_category_id":"standard","tax_category_name":"VAT 23%","tax_rate":"0.23"},"discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"discounts":[{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"shipping_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"version":3}],"id":"order-0000","invoice":null,"invoice_requested":false,"lifecycle_state":"placed","lines":[{"discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"discount_gross":{"amount":"24.60","currency":"PLN","minor_units":2},"discount_net":{"amount":"20.00","currency":"PLN","minor_units":2},"discount_tax":{"amount":"4.60","currency":"PLN","minor_units":2},"discounts":[{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"shipping_amount":null,"version":3}],"identifiers":{},"image":null,"line_id":"saved-line-a","manual_discount":{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"},"name":"Saved A","original_total":{"amount":"246.00","currency":"PLN","minor_units":2},"original_total_gross":{"amount":"246.00","currency":"PLN","minor_units":2},"original_total_net":{"amount":"200.00","currency":"PLN","minor_units":2},"original_total_tax":{"amount":"46.00","currency":"PLN","minor_units":2},"position":1,"product_id":"product-api","quantity":2,"sku":"A","tax":{"amount":"20.70","currency":"PLN","minor_units":2},"tax_category_id":"standard","tax_category_name":"VAT 23%","tax_rate":"0.23","total":{"amount":"221.40","currency":"PLN","minor_units":2},"total_gross":{"amount":"221.40","currency":"PLN","minor_units":2},"total_net":{"amount":"180.00","currency":"PLN","minor_units":2},"total_tax":{"amount":"41.40","currency":"PLN","minor_units":2},"unit_gross":{"amount":"123.00","currency":"PLN","minor_units":2},"unit_net":{"amount":"100.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"123.00","currency":"PLN","minor_units":2},"unit_tax":{"amount":"23.00","currency":"PLN","minor_units":2},"variant_id":null,"variant_options":[]},{"discount_amount":{"amount":"0.00","currency":"PLN","minor_units":2},"discount_gross":{"amount":"0.00","currency":"PLN","minor_units":2},"discount_net":{"amount":"0.00","currency":"PLN","minor_units":2},"discount_tax":{"amount":"0.00","currency":"PLN","minor_units":2},"discounts":[],"identifiers":{},"image":null,"line_id":"b548a171-c331-505f-98f8-db3a06070998","manual_discount":null,"name":"Saved B","original_total":{"amount":"108.00","currency":"PLN","minor_units":2},"original_total_gross":{"amount":"108.00","currency":"PLN","minor_units":2},"original_total_net":{"amount":"100.00","currency":"PLN","minor_units":2},"original_total_tax":{"amount":"8.00","currency":"PLN","minor_units":2},"position":2,"product_id":"deleted-product","quantity":1,"sku":"B","tax":null,"tax_category_id":"reduced","tax_category_name":"VAT 8%","tax_rate":"0.08","total":{"amount":"108.00","currency":"PLN","minor_units":2},"total_gross":{"amount":"108.00","currency":"PLN","minor_units":2},"total_net":{"amount":"100.00","currency":"PLN","minor_units":2},"total_tax":{"amount":"8.00","currency":"PLN","minor_units":2},"unit_gross":{"amount":"108.00","currency":"PLN","minor_units":2},"unit_net":{"amount":"100.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"108.00","currency":"PLN","minor_units":2},"unit_tax":{"amount":"8.00","currency":"PLN","minor_units":2},"variant_id":null,"variant_options":[]}],"locale":"pl","market_id":"market-pl","number":"0001","payment":{"amount":{"amount":"329.40","currency":"PLN","minor_units":2},"environment":"live","method_code":"payment-old","method_name":"Historic method","paid_at":null,"status":"unpaid","updated_at":"2026-10-19T10:00:00Z","version":0},"pickup_point":null,"prices_include_tax":true,"shipping_address":null,"shipping_discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"status":{"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1},"subtotal":{"amount":"329.40","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2},"tax_breakdown":{"groups":[{"gross":{"amount":"221.40","currency":"PLN","minor_units":2},"net":{"amount":"180.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"41.40","currency":"PLN","minor_units":2},"tax_rate":"0.23"},{"gross":{"amount":"108.00","currency":"PLN","minor_units":2},"net":{"amount":"100.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"8.00","currency":"PLN","minor_units":2},"tax_rate":"0.08"},{"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"net":{"amount":"0.00","currency":"PLN","minor_units":2},"source":"shipping","tax":{"amount":"0.00","currency":"PLN","minor_units":2},"tax_rate":"0.23"}],"unallocated_tax":{"amount":"0.00","currency":"PLN","minor_units":2}},"tax_country_code":"PL","total":{"amount":"329.40","currency":"PLN","minor_units":2},"totals":{"before_discounts":{"gross":{"amount":"378.60","currency":"PLN","minor_units":2},"net":{"amount":"320.00","currency":"PLN","minor_units":2},"tax":{"amount":"58.60","currency":"PLN","minor_units":2}},"discounts":{"gross":{"amount":"49.20","currency":"PLN","minor_units":2},"net":{"amount":"40.00","currency":"PLN","minor_units":2},"tax":{"amount":"9.20","currency":"PLN","minor_units":2}},"order":{"gross":{"amount":"329.40","currency":"PLN","minor_units":2},"net":{"amount":"280.00","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2}},"product_discounts":{"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}},"products":{"gross":{"amount":"329.40","currency":"PLN","minor_units":2},"net":{"amount":"280.00","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2}},"products_before_discounts":{"gross":{"amount":"354.00","currency":"PLN","minor_units":2},"net":{"amount":"300.00","currency":"PLN","minor_units":2},"tax":{"amount":"54.00","currency":"PLN","minor_units":2}},"shipping":{"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"net":{"amount":"0.00","currency":"PLN","minor_units":2},"tax":{"amount":"0.00","currency":"PLN","minor_units":2}},"shipping_before_discounts":{"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}},"shipping_discounts":{"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}}}}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必填

响应元数据。

示例: {"request_id":"example-request"}

附加字段: 否

acquired布尔值必填

购买后访问权限 (true / false)

changelog字符串必填

更新说明

covered_by_purchase布尔值必填

购买后访问权限 (true / false)

id字符串必填

资源标识符；请保留返回的原值。

published_at字符串必填

发布版本 · UTC

format: "date-time"

requires_new_purchase布尔值必填

无法访问购买后添加的文件 · requires_new_purchase

sequence整数必填

在有序集合中的位置。

version_label字符串必填

版本

附加字段: 否

email字符串必填

电子邮箱地址。

示例: "customer@example.invalid"

first_name字符串 | null必填

名。

示例: "Example"

last_name字符串 | null必填

姓。

示例: "Example"

phone字符串 | null必填

电话号码。

示例: null

附加字段: 否

expected_version整数必填

写入前读取的版本；不匹配时拒绝更新。

minimum: 1

示例: 1

reason字符串必填

记录的变更原因。

minLength: 1maxLength: 500

示例: "Withdraw a revoked license"

附加字段: 否

dispatch_timezone字符串 | null必填

发货时区 (IANA; null).

示例: "Europe/Warsaw"

estimated_delivery_from字符串 | null必填

预计送达开始日期 (YYYY-MM-DD; null).

字符串:format: "date"

示例: "2026-10-20"

estimated_delivery_to字符串 | null必填

预计送达结束日期 (YYYY-MM-DD; null).

字符串:format: "date"

示例: "2026-10-21"

planned_dispatch_on字符串 | null必填

计划发货日期 (YYYY-MM-DD; null).

字符串:format: "date"

示例: "2026-10-19"

附加字段: 否

expected_unit_version整数必填

空闲替代单元的当前版本。

minimum: 1

示例: 1

expected_version整数必填

写入前读取的版本；不匹配时拒绝更新。

minimum: 1

示例: 1

reason字符串必填

记录的变更原因。

minLength: 1maxLength: 500

示例: "Replace an invalid activation code"

replacement_unit_id字符串必填

现有空闲替代单元的ID。

format: "uuid"

示例: "00000000-0000-4000-8000-000000000008"

附加字段: 否

addressPickupPointAddressData 必填

收货地址。

code字符串必填

稳定的机器可读代码。

约束

pattern

"^[A-Za-z0-9_-]{1,63}$"

coordinatesPickupPointCoordinatesData | null必填

由所在架构描述的值。

country_code字符串必填

国家代码。

约束

pattern

"^[A-Z]{2}$"

environment字符串必填

附加到记录的环境信息。

约束

enum

["live", "sandbox"]

kind字符串必填

由允许值说明的数据结构变体。

约束

enum

["locker", "pickup_point"]

location_description字符串 | null必填

所选语言的描述。

字符串:maxLength: 1000

name字符串必填

对应上下文中的资源名称。

minLength: 1maxLength: 160

opening_hours字符串 | null必填

Opening hours

字符串:maxLength: 500

operator字符串必填

对应上下文中的资源名称。

minLength: 1maxLength: 63

verified_at字符串必填

最近更新时间。

format: "date-time"

附加字段: 否

data数组 <shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData > 必填

成功响应的数据。

示例: [{"can_download":true,"content_state":"present","delete_due_at":null,"filename":null,"first_available_at":"2026-11-03T12:00:00Z","generation":1,"id":"00000000-0000-4000-8000-000000000005","kind":"code","line_id":"line-example","order_id":"order-example","payload_id":"00000000-0000-4000-8000-000000000012","product_id":"example","reason":"","size_bytes":null,"state":"available","unit_id":"00000000-0000-4000-8000-000000000011","unit_ordinal":1,"variant_id":null,"version":2}]

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必填

响应元数据。

示例: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

附加字段: 否

can_download布尔值必填

下载 (true / false)

示例: true

content_state字符串必填

内容状态：present / deleting / deleted。

示例: "present"

delete_due_at字符串 | null必填

计划删除文件的时间，null表示停用自动删除。

字符串:format: "date-time"

示例: null

filename字符串 | null必填

文件

示例: null

first_available_at字符串 | null必填

此次购买首次获得访问权限的时间，替换不会重置期限。

字符串:format: "date-time"

示例: "2026-11-03T12:00:00Z"

generation整数必填

分配代次，替换时递增。

示例: 1

id字符串必填

资源标识符；请保留返回的原值。

format: "uuid"

示例: "00000000-0000-4000-8000-000000000005"

kind字符串 | null必填

由允许值说明的数据结构变体。

示例: "code"

line_id字符串必填

订单项的固定标识符.

示例: "line-example"

order_id字符串必填

相关订单标识符。

示例: "order-example"

payload_id字符串必填

内容ID，不是公开下载URL。

format: "uuid"

示例: "00000000-0000-4000-8000-000000000012"

product_id字符串必填

产品标识符。

示例: "example"

reason字符串必填

记录的变更原因。

示例: ""

size_bytes整数 | null必填

大小（字节）

示例: null

state字符串必填

状态

示例: "available"

unit_id字符串必填

单个兑换码或文件的ID。

format: "uuid"

示例: "00000000-0000-4000-8000-000000000011"

unit_ordinal整数必填

订单项购买数量中的单元序号。

示例: 1

variant_id字符串 | null必填

产品变体标识符。

示例: null

version整数必填

用于并发控制的资源版本。

示例: 2

附加字段: 否

address_line_1字符串 | null必填

第一行地址。

address_line_2字符串 | null必填

附加地址信息。

city字符串 | null必填

城市或地方。

company_name字符串 | null必填

公司名称。

country_code字符串 | null必填

国家代码。

house_number字符串 | null必填

楼号或门牌号。

postal_code字符串 | null必填

邮政编码。

region字符串 | null必填

行政区域。

street字符串 | null必填

街道名称。

tax_identifier字符串 | null必填

税务识别号。

tax_scheme字符串 | null必填

计税方案。

附加字段: 否

grossMoneyData 必填

含税金额 · 折扣后; 未知：null；已知零值：0.

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

netMoneyData | null必填

未税金额 · 折扣后; 未知：null；已知零值：0.

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

taxMoneyData | null必填

税额 · 折扣后; 未知：null；已知零值：0.

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

附加字段: 否

amountMoneyData 必填

含税金额 · 配送 · 折扣.

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

campaign_id字符串必填

资源标识符；请保留返回的原值。

示例: "saved-coupon"

code字符串 | null必填

稳定的机器可读代码。

示例: "SAVE"

kind字符串必填

由允许值说明的数据结构变体。

约束

enum

["coupon", "promotion"]

示例: "coupon"

name字符串必填

对应上下文中的资源名称。

示例: "Saved coupon"

sequence整数 | null必填

在有序集合中的位置。

示例: 1

version整数必填

用于并发控制的资源版本。

示例: 3

附加字段: 否

created_at字符串必填

创建时间。

format: "date-time"

示例: "2026-10-19T10:00:00Z"

customerCustomerData 必填

此资源记录的客户信息。

示例: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}

deliveryShippingDetailData 必填

配送方式及相关信息。

示例: {"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"dates":{"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"},"discount_gross":{"amount":"24.60","currency":"PLN","minor_units":2},"discount_net":{"amount":"20.00","currency":"PLN","minor_units":2},"discount_tax":{"amount":"4.60","currency":"PLN","minor_units":2},"discounts":[{"amount":{"amount":"24.60","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"version":3}],"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"method_code":"shipping-old","method_name":"Historic carrier","net":{"amount":"0.00","currency":"PLN","minor_units":2},"original_gross":{"amount":"24.60","currency":"PLN","minor_units":2},"original_net":{"amount":"20.00","currency":"PLN","minor_units":2},"original_tax":{"amount":"4.60","currency":"PLN","minor_units":2},"pickup_point":null,"recipient_mode":"full_address","tax":{"amount":"0.00","currency":"PLN","minor_units":2},"tax_category_id":"standard","tax_category_name":"VAT 23%","tax_rate":"0.23"}

discount_amountMoneyData 必填

以 JSON 字符串编码的十进制金额；仅在允许时使用 null。

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

discounts数组 <OrderDiscountData > 必填

折扣

示例: [{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"shipping_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"version":3}]

id字符串必填

资源标识符；请保留返回的原值。 (OrderDetailData).

示例: "order-0000"

invoiceInvoiceData | null必填

发票信息。

示例: null

invoice_requested布尔值必填

是否要求开具发票。

示例: false

lifecycle_stateOrderLifecycleState 必填

业务生命周期状态。

示例: "placed"

lines数组 <OrderLineData > 必填

订单行快照。

示例: [{"discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"discount_gross":{"amount":"24.60","currency":"PLN","minor_units":2},"discount_net":{"amount":"20.00","currency":"PLN","minor_units":2},"discount_tax":{"amount":"4.60","currency":"PLN","minor_units":2},"discounts":[{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"shipping_amount":null,"version":3}],"identifiers":{},"image":null,"line_id":"saved-line-a","manual_discount":{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"},"name":"Saved A","original_total":{"amount":"246.00","currency":"PLN","minor_units":2},"original_total_gross":{"amount":"246.00","currency":"PLN","minor_units":2},"original_total_net":{"amount":"200.00","currency":"PLN","minor_units":2},"original_total_tax":{"amount":"46.00","currency":"PLN","minor_units":2},"position":1,"product_id":"product-api","quantity":2,"sku":"A","tax":{"amount":"20.70","currency":"PLN","minor_units":2},"tax_category_id":"standard","tax_category_name":"VAT 23%","tax_rate":"0.23","total":{"amount":"221.40","currency":"PLN","minor_units":2},"total_gross":{"amount":"221.40","currency":"PLN","minor_units":2},"total_net":{"amount":"180.00","currency":"PLN","minor_units":2},"total_tax":{"amount":"41.40","currency":"PLN","minor_units":2},"unit_gross":{"amount":"123.00","currency":"PLN","minor_units":2},"unit_net":{"amount":"100.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"123.00","currency":"PLN","minor_units":2},"unit_tax":{"amount":"23.00","currency":"PLN","minor_units":2},"variant_id":null,"variant_options":[]},{"discount_amount":{"amount":"0.00","currency":"PLN","minor_units":2},"discount_gross":{"amount":"0.00","currency":"PLN","minor_units":2},"discount_net":{"amount":"0.00","currency":"PLN","minor_units":2},"discount_tax":{"amount":"0.00","currency":"PLN","minor_units":2},"discounts":[],"identifiers":{},"image":null,"line_id":"b548a171-c331-505f-98f8-db3a06070998","manual_discount":null,"name":"Saved B","original_total":{"amount":"108.00","currency":"PLN","minor_units":2},"original_total_gross":{"amount":"108.00","currency":"PLN","minor_units":2},"original_total_net":{"amount":"100.00","currency":"PLN","minor_units":2},"original_total_tax":{"amount":"8.00","currency":"PLN","minor_units":2},"position":2,"product_id":"deleted-product","quantity":1,"sku":"B","tax":null,"tax_category_id":"reduced","tax_category_name":"VAT 8%","tax_rate":"0.08","total":{"amount":"108.00","currency":"PLN","minor_units":2},"total_gross":{"amount":"108.00","currency":"PLN","minor_units":2},"total_net":{"amount":"100.00","currency":"PLN","minor_units":2},"total_tax":{"amount":"8.00","currency":"PLN","minor_units":2},"unit_gross":{"amount":"108.00","currency":"PLN","minor_units":2},"unit_net":{"amount":"100.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"108.00","currency":"PLN","minor_units":2},"unit_tax":{"amount":"8.00","currency":"PLN","minor_units":2},"variant_id":null,"variant_options":[]}]

locale字符串必填

本次请求选择的语言。

示例: "pl"

market_id字符串必填

上下文端点返回的市场标识符。

示例: "market-pl"

number字符串必填

面向用户的订单号或申请编号。

示例: "0001"

paymentPaymentData 必填

订单中记录的支付详情。

示例: {"amount":{"amount":"329.40","currency":"PLN","minor_units":2},"environment":"live","method_code":"payment-old","method_name":"Historic method","paid_at":null,"status":"unpaid","updated_at":"2026-10-19T10:00:00Z","version":0}

pickup_pointPickupPointData | null必填

取件地点

示例: null

prices_include_tax布尔值必填

列出的价格是否含税。

示例: true

shipping_addressAddressData | null必填

收货地址。

示例: null

shipping_discount_amountMoneyData 必填

以 JSON 字符串编码的十进制金额；仅在允许时使用 null。

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

statusOrderStatusData 必填

此操作接受的状态。

示例: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}

subtotalMoneyData 必填

加入响应中所示附加组成部分之前的金额。

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

taxMoneyData 必填

税务信息。

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

tax_breakdownOrderTaxBreakdownData 必填

税务分组 · source + tax_rate; unallocated_tax.

示例: {"groups":[{"gross":{"amount":"221.40","currency":"PLN","minor_units":2},"net":{"amount":"180.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"41.40","currency":"PLN","minor_units":2},"tax_rate":"0.23"},{"gross":{"amount":"108.00","currency":"PLN","minor_units":2},"net":{"amount":"100.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"8.00","currency":"PLN","minor_units":2},"tax_rate":"0.08"},{"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"net":{"amount":"0.00","currency":"PLN","minor_units":2},"source":"shipping","tax":{"amount":"0.00","currency":"PLN","minor_units":2},"tax_rate":"0.23"}],"unallocated_tax":{"amount":"0.00","currency":"PLN","minor_units":2}}

tax_country_code字符串 | null必填

征税国家 · 已保存的订单数据 · ISO 3166-1 alpha-2; null.

示例: "PL"

totalMoneyData 必填

总金额。

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

totalsOrderTotalsData 必填

合计 · net / tax / gross; 折扣前 / 折扣后.

示例: {"before_discounts":{"gross":{"amount":"378.60","currency":"PLN","minor_units":2},"net":{"amount":"320.00","currency":"PLN","minor_units":2},"tax":{"amount":"58.60","currency":"PLN","minor_units":2}},"discounts":{"gross":{"amount":"49.20","currency":"PLN","minor_units":2},"net":{"amount":"40.00","currency":"PLN","minor_units":2},"tax":{"amount":"9.20","currency":"PLN","minor_units":2}},"order":{"gross":{"amount":"329.40","currency":"PLN","minor_units":2},"net":{"amount":"280.00","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2}},"product_discounts":{"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}},"products":{"gross":{"amount":"329.40","currency":"PLN","minor_units":2},"net":{"amount":"280.00","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2}},"products_before_discounts":{"gross":{"amount":"354.00","currency":"PLN","minor_units":2},"net":{"amount":"300.00","currency":"PLN","minor_units":2},"tax":{"amount":"54.00","currency":"PLN","minor_units":2}},"shipping":{"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"net":{"amount":"0.00","currency":"PLN","minor_units":2},"tax":{"amount":"0.00","currency":"PLN","minor_units":2}},"shipping_before_discounts":{"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}},"shipping_discounts":{"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}}}

附加字段: 否

can_download布尔值必填

下载 (true / false)

示例: true

categoryFileCategory 必填

文件类别: internal / customer_document / digital

示例: "digital"

filename字符串必填

文件

示例: "manual.pdf"

id字符串必填

资源标识符；请保留返回的原值。

示例: "example"

label字符串必填

对应上下文中的资源名称。

示例: "Manual"

line_id字符串必填

订单项的固定标识符.

示例: "example"

mime_type字符串必填

媒体内容类型。

示例: "application/pdf"

product_id字符串必填

产品标识符。

示例: "example"

purchase_id字符串必填

资源标识符；请保留返回的原值。 · purchase_id

示例: "00000000-0000-4000-8000-000000000001"

reason字符串必填

记录的变更原因。

示例: "paid"

sha256字符串必填

SHA-256 (hex, 64)

示例: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"

size_bytes整数必填

大小（字节）

minimum: 1maximum: 262144000

示例: 46

source_file_id字符串必填

资源标识符；请保留返回的原值。 · source_file_id

示例: "00000000-0000-4000-8000-000000000001"

source_version_id字符串必填

资源标识符；请保留返回的原值。 · source_version_id

示例: "00000000-0000-4000-8000-000000000001"

source_version_number整数必填

版本

minimum: 1

示例: 1

state字符串必填

状态

示例: "active"

附加字段: 否

files数组 <OrderFileData > 必填

商品文件

示例: [{"can_download":true,"category":"digital","filename":"manual.pdf","id":"example","label":"Manual","line_id":"example","mime_type":"application/pdf","product_id":"example","purchase_id":"00000000-0000-4000-8000-000000000001","reason":"paid","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"source_file_id":"00000000-0000-4000-8000-000000000001","source_version_id":"00000000-0000-4000-8000-000000000001","source_version_number":1,"state":"active"}]

updates_pending布尔值必填

购买后对未来文件的访问权限 · updates_pending

示例: false

附加字段: 否

alt字符串 | null必填

图片替代文本。

source字符串可选

记录活动的来源。

const: "current_catalog"

默认值: "current_catalog"

url字符串必填

资源 URL。

附加字段: 否

附加字段: 是

discount_amountMoneyData 必填

以 JSON 字符串编码的十进制金额；仅在允许时使用 null。

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

discount_grossMoneyData 必填

含税金额 · 折扣; 未知：null；已知零值：0.

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

discount_netMoneyData | null必填

未税金额 · 折扣; 未知：null；已知零值：0.

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

discount_taxMoneyData | null必填

税额 · 折扣; 未知：null；已知零值：0.

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

discounts数组 <OrderDiscountData > 必填

折扣 · net / tax / gross.

示例: [{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"shipping_amount":null,"version":3}]

identifiers对象附加字段: 字符串必填

产品识别代码。

示例: {}

imageOrderImageData | null必填

图片元数据和 URL。

示例: null

line_id字符串必填

订单项的固定标识符.

示例: "saved-line-a"

manual_discountOrderManualDiscountData | null必填

手动折扣; null.

示例: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}

name字符串必填

对应上下文中的资源名称。

示例: "Saved A"

original_totalMoneyData 必填

总金额。

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

original_total_grossMoneyData 必填

含税金额 · 商品 · 折扣前; 未知：null；已知零值：0.

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

original_total_netMoneyData | null必填

未税金额 · 商品 · 折扣前; 未知：null；已知零值：0.

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

original_total_taxMoneyData | null必填

税额 · 商品 · 折扣前; 未知：null；已知零值：0.

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

position整数必填

在有序集合中的位置。

示例: 1

product_id字符串必填

产品标识符。

示例: "product-api"

quantity整数必填

单位数量。

示例: 2

sku字符串必填

库存单位代码。

示例: "A"

taxMoneyData | null必填

税额 · 单件 · 已保存的订单数据; tax ≠ unit_tax; 未知：null；已知零值：0.

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

tax_category_id字符串 | null必填

税务类别标识符 · 已保存的订单数据; null.

示例: "standard"

tax_category_name字符串 | null必填

已保存的税务类别名称; null.

示例: "VAT 23%"

tax_rate字符串 | null必填

tax_rate · 已保存的订单数据: "0.23" = 23%; "0" ≠ null.

示例: "0.23"

totalMoneyData 必填

总金额。

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

total_grossMoneyData 必填

含税金额 · 商品 · 折扣后; 未知：null；已知零值：0.

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

total_netMoneyData | null必填

未税金额 · 商品 · 折扣后; 未知：null；已知零值：0.

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

total_taxMoneyData | null必填

税额 · 商品 · 折扣后 · 已保存的订单数据; 未知：null；已知零值：0.

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

unit_grossMoneyData 必填

含税金额 · 单件 · 折扣前; 未知：null；已知零值：0.

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

unit_netMoneyData | null必填

未税金额 · 单件 · 折扣前; 未知：null；已知零值：0.

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

unit_priceMoneyData 必填

单价。

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

unit_taxMoneyData | null必填

税额 · 单件 · 折扣前; 未知：null；已知零值：0.

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

variant_id字符串 | null必填

产品变体标识符。

示例: null

variant_options数组 <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > 必填

与产品或快照关联的变体选项。

示例: []

附加字段: 否

amountMoneyData 必填

含税金额 · 手动折扣 · 已保存的订单数据.

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

kind字符串必填

折扣类型: percentage / fixed.

约束

enum

["percentage", "fixed"]

示例: "fixed"

value字符串必填

配置值: percentage "10" = 10%; fixed = 含税金额.

示例: "12.30"

附加字段: 否

附加字段: 是

access_reason字符串必填

购买后访问权限 · 记录的变更原因。

示例: "paid"

access_state字符串必填

购买后访问权限 · 状态

示例: "active"

current_releaseCurrentReleaseData | null必填

数字版本 · current_release

示例: null

grant_reason字符串必填

购买后访问权限 · 记录的变更原因。

示例: "purchase"

granted_at字符串必填

购买后访问权限 · UTC

format: "date-time"

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

id字符串必填

资源标识符；请保留返回的原值。

示例: "example"

line_id字符串必填

订单项的固定标识符.

示例: "example"

manifest_sha256字符串必填

数字版本 · SHA-256

示例: "1111111111111111111111111111111111111111111111111111111111111111"

product_id字符串必填

产品标识符。

示例: "example"

published_at字符串必填

发布版本 · UTC

format: "date-time"

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

purchase_id字符串必填

资源标识符；请保留返回的原值。 · purchase_id

示例: "00000000-0000-4000-8000-000000000001"

release_id字符串必填

资源标识符；请保留返回的原值。 · release_id

示例: "00000000-0000-4000-8000-000000000001"

release_sequence整数必填

数字版本 · 在有序集合中的位置。

示例: 1

update_days整数 | null必填

天数 (days; null)

示例: 365

update_mode字符串必填

购买后对未来文件的访问权限: none / period / unlimited

示例: "period"

update_months整数 | null必填

月数 (months; null)

示例: null

updates_until字符串 | null必填

购买后对未来文件的访问权限 · UTC

字符串:format: "date-time"

示例: "2027-01-01T12:00:00Z"

version_label字符串必填

版本

示例: "1.0"

附加字段: 否

releases数组 <OrderReleaseData > 必填

数字版本

示例: [{"access_reason":"paid","access_state":"active","current_release":null,"grant_reason":"purchase","granted_at":"2026-01-01T12:00:00Z","id":"example","line_id":"example","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","product_id":"example","published_at":"2026-01-01T12:00:00Z","purchase_id":"00000000-0000-4000-8000-000000000001","release_id":"00000000-0000-4000-8000-000000000001","release_sequence":1,"update_days":365,"update_mode":"period","update_months":null,"updates_until":"2027-01-01T12:00:00Z","version_label":"1.0"}]

updates_pending布尔值必填

购买后对未来文件的访问权限 · updates_pending

示例: false

附加字段: 否

id字符串必填

资源标识符；请保留返回的原值。 (OrderStatusData).

示例: "status-0"

name字符串必填

对应上下文中的资源名称。

示例: "Status 0"

updated_at字符串必填

最近更新时间。

format: "date-time"

示例: "2026-10-19T10:00:00Z"

version整数必填

用于并发控制的资源版本。

示例: 1

附加字段: 否

created_at字符串必填

创建时间。

format: "date-time"

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

id字符串必填

资源标识符；请保留返回的原值。 (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

示例: "status-0"

is_initial布尔值必填

是否为初始状态。

示例: true

name字符串必填

对应上下文中的资源名称。

示例: "New"

position整数必填

在有序集合中的位置。

示例: 0

附加字段: 否

data数组 <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > 必填

响应示例 · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

示例: [{"created_at":"2026-01-01T12:00:00Z","id":"status-0","is_initial":true,"name":"New","position":0},{"created_at":"2026-01-01T12:00:00Z","id":"status-1","is_initial":false,"name":"Processing","position":1}]

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

示例: "status-1"

附加字段: 否

created_at字符串必填

创建时间。

format: "date-time"

示例: "2026-10-19T10:00:00Z"

customerCustomerData 必填

此资源记录的客户信息。

示例: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}

deliveryShippingData 必填

配送方式及相关信息。

示例: {"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"dates":{"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"},"method_code":"shipping-old","method_name":"Historic carrier","pickup_point":null,"recipient_mode":"full_address"}

discount_amountMoneyData 必填

以 JSON 字符串编码的十进制金额；仅在允许时使用 null。

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

id字符串必填

资源标识符；请保留返回的原值。 (OrderSummaryData).

示例: "order-0000"

lifecycle_stateOrderLifecycleState 必填

业务生命周期状态。

示例: "placed"

locale字符串必填

本次请求选择的语言。

示例: "pl"

market_id字符串必填

上下文端点返回的市场标识符。

示例: "market-pl"

number字符串必填

面向用户的订单号或申请编号。

示例: "0001"

paymentPaymentData 必填

订单中记录的支付详情。

示例: {"amount":{"amount":"329.40","currency":"PLN","minor_units":2},"environment":"live","method_code":"payment-old","method_name":"Historic method","paid_at":null,"status":"unpaid","updated_at":"2026-10-19T10:00:00Z","version":0}

prices_include_tax布尔值必填

列出的价格是否含税。

示例: true

shipping_discount_amountMoneyData 必填

以 JSON 字符串编码的十进制金额；仅在允许时使用 null。

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

statusOrderStatusData 必填

此操作接受的状态。

示例: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}

subtotalMoneyData 必填

加入响应中所示附加组成部分之前的金额。

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

taxMoneyData 必填

税务信息。

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

tax_country_code字符串 | null必填

征税国家 · 已保存的订单数据 · ISO 3166-1 alpha-2; null.

示例: "PL"

totalMoneyData 必填

总金额。

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

附加字段: 否

groups数组 <OrderTaxGroupData > 必填

税务分组 · source + tax_rate; 未知：null；已知零值：0.

示例: [{"gross":{"amount":"221.40","currency":"PLN","minor_units":2},"net":{"amount":"180.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"41.40","currency":"PLN","minor_units":2},"tax_rate":"0.23"},{"gross":{"amount":"108.00","currency":"PLN","minor_units":2},"net":{"amount":"100.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"8.00","currency":"PLN","minor_units":2},"tax_rate":"0.08"},{"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"net":{"amount":"0.00","currency":"PLN","minor_units":2},"source":"shipping","tax":{"amount":"0.00","currency":"PLN","minor_units":2},"tax_rate":"0.23"}]

unallocated_taxMoneyData 必填

未分配税额 = order.tax − Σ groups.tax; ±.

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

附加字段: 否

grossMoneyData 必填

含税金额 · 折扣后; 未知：null；已知零值：0.

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

netMoneyData | null必填

未税金额 · 折扣后; 未知：null；已知零值：0.

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

source字符串必填

来源: products (商品), shipping (配送).

约束

enum

["products", "shipping"]

示例: "products"

taxMoneyData | null必填

税额 · 折扣后; 未知：null；已知零值：0.

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

tax_rate字符串 | null必填

tax_rate · 已保存的订单数据: "0.23" = 23%; "0" ≠ null.

示例: "0.23"

附加字段: 否

before_discountsOrderAmountBreakdownData 必填

订单 · 折扣前 · net / tax / gross.

示例: {"gross":{"amount":"378.60","currency":"PLN","minor_units":2},"net":{"amount":"320.00","currency":"PLN","minor_units":2},"tax":{"amount":"58.60","currency":"PLN","minor_units":2}}

discountsOrderAmountBreakdownData 必填

折扣 · net / tax / gross.

示例: {"gross":{"amount":"49.20","currency":"PLN","minor_units":2},"net":{"amount":"40.00","currency":"PLN","minor_units":2},"tax":{"amount":"9.20","currency":"PLN","minor_units":2}}

orderOrderAmountBreakdownData 必填

订单 · 折扣后 · net / tax / gross.

示例: {"gross":{"amount":"329.40","currency":"PLN","minor_units":2},"net":{"amount":"280.00","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2}}

product_discountsOrderAmountBreakdownData 必填

商品 · 折扣 · net / tax / gross.

示例: {"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}}

productsOrderAmountBreakdownData 必填

商品 · 折扣后 · net / tax / gross.

示例: {"gross":{"amount":"329.40","currency":"PLN","minor_units":2},"net":{"amount":"280.00","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2}}

products_before_discountsOrderAmountBreakdownData 必填

商品 · 折扣前 · net / tax / gross.

示例: {"gross":{"amount":"354.00","currency":"PLN","minor_units":2},"net":{"amount":"300.00","currency":"PLN","minor_units":2},"tax":{"amount":"54.00","currency":"PLN","minor_units":2}}

shippingOrderAmountBreakdownData 必填

配送 · 折扣后 · net / tax / gross.

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

shipping_before_discountsOrderAmountBreakdownData 必填

配送 · 折扣前 · net / tax / gross.

示例: {"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}}

shipping_discountsOrderAmountBreakdownData 必填

配送 · 折扣 · net / tax / gross.

示例: {"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}}

附加字段: 否

name字符串必填

对应上下文中的资源名称。

value字符串必填

由所在架构描述的值。

附加字段: 否

amountMoneyData 必填

含税金额 · 商品 · 折扣.

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

campaign_id字符串必填

资源标识符；请保留返回的原值。

示例: "saved-coupon"

code字符串 | null必填

稳定的机器可读代码。

示例: "SAVE"

kind字符串必填

由允许值说明的数据结构变体。

约束

enum

["coupon", "promotion"]

示例: "coupon"

name字符串必填

对应上下文中的资源名称。

示例: "Saved coupon"

sequence整数 | null可选

应用顺序; null.

示例: 1

shipping_amountMoneyData | null可选

含税金额 · 配送 · 折扣; null.

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

version整数必填

用于并发控制的资源版本。

示例: 3

附加字段: 否

amountMoneyData 必填

payment.amount 是订单总额。付款状态不能确定已付、已退款或待付金额。

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

environment字符串必填

附加到记录的环境信息。

约束

enum

["live", "sandbox"]

示例: "live"

method_code字符串 | null必填

配送或支付方式代码。

示例: "payment-old"

method_name字符串 | null必填

配送或支付方式名称。

示例: "Historic method"

paid_at字符串 | null必填

支付被标记为已付的日期和时间。

字符串:format: "date-time"

示例: null

statusOrderPaymentStatus 必填

此操作接受的状态。

示例: "unpaid"

updated_at字符串必填

最近更新时间。

format: "date-time"

示例: "2026-10-19T10:00:00Z"

version整数必填

用于并发控制的资源版本。

示例: 0

附加字段: 否

expected_version整数必填

写入前读取的版本；不匹配时拒绝更新。

minimum: 0maximum: 9223372036854775807

示例: 0

reason字符串必填

记录的变更原因。

minLength: 1maxLength: 500

示例: "Bank transfer confirmed"

statusPaymentStatus 必填

此操作接受的状态。 unpaid: 未付款; paid: 已付款; failed: 付款失败; refunded: 已退款.

示例: "paid"

附加字段: 否

附加字段: 是

address_line_1字符串必填

第一行地址。

minLength: 1maxLength: 240

city字符串必填

城市或地方。

minLength: 1maxLength: 160

postal_code字符串必填

邮政编码。

minLength: 1maxLength: 32

附加字段: 否

latitude数值必填

WGS84 φ (°)

minimum: -90.0maximum: 90.0

longitude数值必填

WGS84 λ (°)

minimum: -180.0maximum: 180.0

附加字段: 否

address_line1字符串必填

第一行地址。

city字符串必填

城市或地方。

code字符串必填

稳定的机器可读代码。

country_code字符串必填

国家代码。

kind字符串必填

由允许值说明的数据结构变体。

约束

enum

["locker", "pickup_point"]

latitude数值 | null必填

WGS84 φ (°)

location_description字符串 | null必填

所选语言的描述。

longitude数值 | null必填

WGS84 λ (°)

name字符串必填

对应上下文中的资源名称。

opening_hours字符串 | null必填

Opening hours

operator字符串必填

对应上下文中的资源名称。

postal_code字符串必填

邮政编码。

附加字段: 否

code字符串必填

稳定的机器可读代码。

约束

pattern

"^[A-Za-z0-9_-]{1,63}$"

country_code字符串必填

国家代码。

约束

pattern

"^[A-Z]{2}$"

environment字符串必填

附加到记录的环境信息。

约束

enum

["live", "sandbox"]

kind字符串必填

由允许值说明的数据结构变体。

约束

enum

["locker", "pickup_point"]

operator字符串必填

对应上下文中的资源名称。

minLength: 1maxLength: 63

附加字段: 否

email字符串必填

电子邮箱地址。

示例: "customer@example.invalid"

name字符串必填

对应上下文中的资源名称。

示例: "Example"

附加字段: 否

amountMoneyData 必填

订单中以 MoneyData 记录的含税配送金额。后续税率变更不会改变此历史金额。

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

datesDeliveryDatesData 必填

发货及预计送达日期. 订单列表和详情均包含 delivery.dates。YYYY-MM-DD 格式的日期为计划日期，不代表已发货。当前日期优先；旧订单使用已保存的估计。已清除或未知的值为 null。详情还包含所有订单项和商品图片。

示例: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}

method_code字符串 | null必填

配送或支付方式代码。

示例: "shipping-old"

method_name字符串 | null必填

配送或支付方式名称。

示例: "Historic carrier"

pickup_pointPickupPointSummaryData | null必填

取件地点

示例: null

recipient_mode字符串必填

由允许值说明的数据结构变体。

约束

enum

["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]

示例: "full_address"

附加字段: 否

amountMoneyData 必填

订单中以 MoneyData 记录的含税配送金额。后续税率变更不会改变此历史金额。

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

datesDeliveryDatesData 必填

发货及预计送达日期. 订单列表和详情均包含 delivery.dates。YYYY-MM-DD 格式的日期为计划日期，不代表已发货。当前日期优先；旧订单使用已保存的估计。已清除或未知的值为 null。详情还包含所有订单项和商品图片。

示例: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}

discount_grossMoneyData 必填

含税金额 · 折扣; 未知：null；已知零值：0.

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

discount_netMoneyData | null必填

未税金额 · 折扣; 未知：null；已知零值：0.

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

discount_taxMoneyData | null必填

税额 · 折扣; 未知：null；已知零值：0.

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

discounts数组 <OrderDeliveryDiscountData > | null必填

配送 · 折扣; []: 0; null: 未知：null；已知零值：0.

示例: [{"amount":{"amount":"24.60","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"version":3}]

grossMoneyData 必填

含税金额 · 折扣后; 未知：null；已知零值：0.

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

method_code字符串 | null必填

配送或支付方式代码。

示例: "shipping-old"

method_name字符串 | null必填

配送或支付方式名称。

示例: "Historic carrier"

netMoneyData | null必填

未税金额 · 折扣后; 未知：null；已知零值：0.

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

original_grossMoneyData 必填

含税金额 · 配送 · 折扣前; 未知：null；已知零值：0.

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

original_netMoneyData | null必填

未税金额 · 配送 · 折扣前; 未知：null；已知零值：0.

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

original_taxMoneyData | null必填

税额 · 配送 · 折扣前; 未知：null；已知零值：0.

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

pickup_pointDeliveryPickupPointData | null必填

取件地点

示例: null

recipient_mode字符串必填

由允许值说明的数据结构变体。

约束

enum

["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]

示例: "full_address"

taxMoneyData | null必填

税额 · 折扣后; 未知：null；已知零值：0.

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

tax_category_id字符串 | null必填

税务类别标识符 · 已保存的订单数据; null.

示例: "standard"

tax_category_name字符串 | null必填

已保存的税务类别名称; null.

示例: "VAT 23%"

tax_rate字符串 | null必填

tax_rate · 已保存的订单数据: "0.23" = 23%; "0" ≠ null.

示例: "0.23"

附加字段: 否