資料架構: 訂單

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"

附加欄位: 否