資料架構
收貨位址
AddressData · 架構 · 資料架構: 訂單
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必填街道名稱。
附加欄位: 否
取得清單 — 訂單 — 回應
ApiResponse_list_OrderSummaryData__ · API 接收或傳回的資料欄位、類型和限制。
data陣列 <OrderSummaryData> 必填回應示例 · ApiResponse_list_OrderSummaryData__.
metaContextPageMetaContextMetaPageMetaRequestMeta必填回應元資料。
附加欄位: 否
取得 — 訂單 — 回應
ApiResponse_OrderDetailData_ · API 接收或傳回的資料欄位、類型和限制。
dataOrderDetailData必填回應示例 · OrderDetailData.
metaContextPageMetaContextMetaPageMetaRequestMeta必填回應元資料。
附加欄位: 否
此資源記錄的客戶資訊
CustomerData · 架構 · 資料架構: 訂單
email字串必填電子郵箱位址。
first_name字串 null必填名。
last_name字串 null必填姓。
phone字串 null必填電話號碼。
附加欄位: 否
出貨及預計送達日期
DeliveryDatesData · 訂單列表和詳細資料均包含 delivery.dates。YYYY-MM-DD 格式的日期為計畫日期，不代表已出貨。目前日期優先；舊訂單使用已儲存的估計。已清除或未知的值為 null。詳細資料還包含所有訂單項目和商品圖片。
dispatch_timezone字串 null必填出貨時區 (IANA; null).
estimated_delivery_from字串 null必填預計送達開始日期 (YYYY-MM-DD; null).
字串:format:"date"estimated_delivery_to字串 null必填預計送達結束日期 (YYYY-MM-DD; null).
字串:format:"date"planned_dispatch_on字串 null必填計畫出貨日期 (YYYY-MM-DD; null).
字串:format:"date"
附加欄位: 否
DeliveryPickupPointData
DeliveryPickupPointData · API 接收或傳回的資料欄位、類型和限制。
addressPickupPointAddressData必填收貨位址。
code字串必填穩定的機器可讀代碼。
約束
pattern"^[A-Za-z0-9_-]{1,63}$"
coordinatesPickupPointCoordinatesDatanull必填由所在架構描述的值。
country_code字串必填國家代碼。
約束
pattern"^[A-Z]{2}$"
environment字串必填附加到記錄的環境資訊。
約束
enum["live", "sandbox"]
kind字串必填由允許值說明的資料結構變體。
約束
enum["locker", "pickup_point"]
location_description字串 null必填所選語言的描述。
字串:maxLength:1000name字串必填對應上下文中的資源名稱。
minLength:1maxLength:160opening_hours字串 null必填Opening hours
字串:maxLength:500operator字串必填對應上下文中的資源名稱。
minLength:1maxLength:63verified_at字串必填最近更新時間。
format:"date-time"
附加欄位: 否
發票資訊
InvoiceData · 架構 · 資料架構: 訂單
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必填計稅方案。
附加欄位: 否
配送 · 折扣
OrderDeliveryDiscountData · 金額和稅率取自已儲存的訂單，包括訂單項目的更正。缺少的歷史資料為 null，不會用目前商品目錄的稅率補齊。金額始終維持為十進位字串。
amountMoneyData必填含稅金額 · 配送 · 折扣.
campaign_id字串必填資源識別碼；請保留回傳的原值。
code字串 null必填穩定的機器可讀代碼。
kind字串必填由允許值說明的資料結構變體。
約束
enum["coupon", "promotion"]
name字串必填對應上下文中的資源名稱。
sequence整數 null必填在有序集合中的位置。
version整數必填用於並行控制的資源版本。
附加欄位: 否
取得 — 訂單 — 回應
OrderDetailData · API 接收或傳回的資料欄位、類型和限制。
created_at字串必填建立時間。
format:"date-time"customerCustomerData必填此資源記錄的客戶資訊。
deliveryShippingDetailData必填配送方式及相關資訊。
discount_amountMoneyData必填以 JSON 字串編碼的十進位金額；僅在允許時使用 null。
discounts陣列 <OrderDiscountData> 必填折扣
id字串必填資源識別碼；請保留回傳的原值。 (OrderDetailData).
invoiceInvoiceDatanull必填發票資訊。
invoice_requested布林值必填是否要求開具發票。
lifecycle_stateOrderLifecycleState必填業務生命週期狀態。
lines陣列 <OrderLineData> 必填訂單行快照。
locale字串必填本次請求選擇的語言。
market_id字串必填上下文端點回傳的市場識別碼。
number字串必填面向使用者的訂單號或申請編號。
paymentPaymentData必填訂單中記錄的支付詳情。
pickup_pointPickupPointDatanull必填取件地點
prices_include_tax布林值必填列出的價格是否含稅。
shipping_addressAddressDatanull必填收貨位址。
shipping_discount_amountMoneyData必填以 JSON 字串編碼的十進位金額；僅在允許時使用 null。
statusOrderStatusData必填此操作接受的狀態。
subtotalMoneyData必填加入回應中所示附加組成部分之前的金額。
taxMoneyData必填稅務資訊。
tax_breakdownOrderTaxBreakdownData必填稅務分組 · source + tax_rate; unallocated_tax.
tax_country_code字串 null必填課稅國家 · 已儲存的訂單資料 · ISO 3166-1 alpha-2; null.
totalMoneyData必填總金額。
totalsOrderTotalsData必填合計 · net / tax / gross; 折扣前 / 折扣後.
附加欄位: 否
圖片元資料和 URL
OrderImageData · 架構 · 資料架構: 訂單
alt字串 null必填圖片替代文本。
source字串選填記錄活動的來源。
const:"current_catalog"url字串必填資源 URL。
附加欄位: 否
業務生命週期狀態
OrderLifecycleState · 架構 · 資料架構: 訂單
字串約束
enum["placed", "cancelled", "fulfilled", "returned"]
附加欄位: 是
訂單行快照
OrderLineData · 架構 · 資料架構: 訂單
discount_amountMoneyData必填以 JSON 字串編碼的十進位金額；僅在允許時使用 null。
discount_grossMoneyData必填含稅金額 · 折扣; 未知：null；已知零值：0.
discount_netMoneyDatanull必填未稅金額 · 折扣; 未知：null；已知零值：0.
discount_taxMoneyDatanull必填稅額 · 折扣; 未知：null；已知零值：0.
discounts陣列 <OrderDiscountData> 必填折扣 · net / tax / gross.
identifiers物件附加欄位: 字串必填產品識別代碼。
imageOrderImageDatanull必填圖片元資料和 URL。
line_id字串必填訂單項目的固定識別碼.
manual_discountOrderManualDiscountDatanull必填手動折扣; null.
name字串必填對應上下文中的資源名稱。
original_totalMoneyData必填總金額。
original_total_grossMoneyData必填含稅金額 · 商品 · 折扣前; 未知：null；已知零值：0.
original_total_netMoneyDatanull必填未稅金額 · 商品 · 折扣前; 未知：null；已知零值：0.
original_total_taxMoneyDatanull必填稅額 · 商品 · 折扣前; 未知：null；已知零值：0.
position整數必填在有序集合中的位置。
product_id字串必填產品識別碼。
quantity整數必填單位數量。
sku字串必填庫存單位代碼。
taxMoneyDatanull必填稅額 · 單件 · 已儲存的訂單資料; tax ≠ unit_tax; 未知：null；已知零值：0.
tax_category_id字串 null必填稅務類別識別碼 · 已儲存的訂單資料; null.
tax_category_name字串 null必填已儲存的稅務類別名稱; null.
tax_rate字串 null必填tax_rate · 已儲存的訂單資料: "0.23" = 23%; "0" ≠ null.
totalMoneyData必填總金額。
total_grossMoneyData必填含稅金額 · 商品 · 折扣後; 未知：null；已知零值：0.
total_netMoneyDatanull必填未稅金額 · 商品 · 折扣後; 未知：null；已知零值：0.
total_taxMoneyDatanull必填稅額 · 商品 · 折扣後 · 已儲存的訂單資料; 未知：null；已知零值：0.
unit_grossMoneyData必填含稅金額 · 單件 · 折扣前; 未知：null；已知零值：0.
unit_netMoneyDatanull必填未稅金額 · 單件 · 折扣前; 未知：null；已知零值：0.
unit_priceMoneyData必填單價。
unit_taxMoneyDatanull必填稅額 · 單件 · 折扣前; 未知：null；已知零值：0.
variant_id字串 null必填產品變體識別碼。
variant_options陣列 <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData> 必填與產品或快照關聯的變體選項。
附加欄位: 否
手動折扣
OrderManualDiscountData · 金額和稅率取自已儲存的訂單，包括訂單項目的更正。缺少的歷史資料為 null，不會用目前商品目錄的稅率補齊。金額始終維持為十進位字串。
amountMoneyData必填含稅金額 · 手動折扣 · 已儲存的訂單資料.
kind字串必填折扣類型: percentage / fixed.
約束
enum["percentage", "fixed"]
value字串必填設定值: percentage "10" = 10%; fixed = 含稅金額.
附加欄位: 否
此操作接受的狀態
OrderPaymentStatus · 架構 · 資料架構: 訂單
字串約束
enum["unpaid", "paid", "failed", "refunded"]
附加欄位: 是
此操作接受的狀態
OrderStatusData · 架構 · 資料架構: 訂單
id字串必填資源識別碼；請保留回傳的原值。 (OrderStatusData).
name字串必填對應上下文中的資源名稱。
updated_at字串必填最近更新時間。
format:"date-time"version整數必填用於並行控制的資源版本。
附加欄位: 否
取得清單 · 狀態清單 — 訂單 — 回應
shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · API 接收或傳回的資料欄位、類型和限制。
created_at字串必填建立時間。
format:"date-time"id字串必填資源識別碼；請保留回傳的原值。 (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).
is_initial布林值必填是否為初始狀態。
name字串必填對應上下文中的資源名稱。
position整數必填在有序集合中的位置。
附加欄位: 否
取得清單 · 狀態清單 — 訂單 — 回應
shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · API 接收或傳回的資料欄位、類型和限制。
data陣列 <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData> 必填回應示例 · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.
metaContextPageMetaContextMetaPageMetaRequestMeta必填回應元資料。
附加欄位: 否
更新 · 狀態 — 訂單 — 請求本文
OrderStatusUpdate · API 接收或傳回的資料欄位、類型和限制。
expected_version整數必填寫入前讀取的版本；不匹配時拒絕更新。
minimum:1maximum:9223372036854775807status_id字串必填從相應狀態字典取得的識別碼。
約束
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
附加欄位: 否
取得清單 — 訂單 — 回應
OrderSummaryData · API 接收或傳回的資料欄位、類型和限制。
created_at字串必填建立時間。
format:"date-time"customerCustomerData必填此資源記錄的客戶資訊。
deliveryShippingData必填配送方式及相關資訊。
discount_amountMoneyData必填以 JSON 字串編碼的十進位金額；僅在允許時使用 null。
id字串必填資源識別碼；請保留回傳的原值。 (OrderSummaryData).
lifecycle_stateOrderLifecycleState必填業務生命週期狀態。
locale字串必填本次請求選擇的語言。
market_id字串必填上下文端點回傳的市場識別碼。
number字串必填面向使用者的訂單號或申請編號。
paymentPaymentData必填訂單中記錄的支付詳情。
prices_include_tax布林值必填列出的價格是否含稅。
shipping_discount_amountMoneyData必填以 JSON 字串編碼的十進位金額；僅在允許時使用 null。
statusOrderStatusData必填此操作接受的狀態。
subtotalMoneyData必填加入回應中所示附加組成部分之前的金額。
taxMoneyData必填稅務資訊。
tax_country_code字串 null必填課稅國家 · 已儲存的訂單資料 · ISO 3166-1 alpha-2; null.
totalMoneyData必填總金額。
附加欄位: 否
訂單 · 稅務分組
OrderTaxBreakdownData · 金額和稅率取自已儲存的訂單，包括訂單項目的更正。缺少的歷史資料為 null，不會用目前商品目錄的稅率補齊。金額始終維持為十進位字串。
groups陣列 <OrderTaxGroupData> 必填稅務分組 · source + tax_rate; 未知：null；已知零值：0.
unallocated_taxMoneyData必填未分配稅額 = order.tax − Σ groups.tax; ±.
附加欄位: 否
稅務分組
OrderTaxGroupData · 金額和稅率取自已儲存的訂單，包括訂單項目的更正。缺少的歷史資料為 null，不會用目前商品目錄的稅率補齊。金額始終維持為十進位字串。
grossMoneyData必填含稅金額 · 折扣後; 未知：null；已知零值：0.
netMoneyDatanull必填未稅金額 · 折扣後; 未知：null；已知零值：0.
source字串必填來源: products (商品), shipping (配送).
約束
enum["products", "shipping"]
taxMoneyDatanull必填稅額 · 折扣後; 未知：null；已知零值：0.
tax_rate字串 null必填tax_rate · 已儲存的訂單資料: "0.23" = 23%; "0" ≠ null.
附加欄位: 否
訂單 · 合計
OrderTotalsData · 金額和稅率取自已儲存的訂單，包括訂單項目的更正。缺少的歷史資料為 null，不會用目前商品目錄的稅率補齊。金額始終維持為十進位字串。
before_discountsOrderAmountBreakdownData必填訂單 · 折扣前 · net / tax / gross.
discountsOrderAmountBreakdownData必填折扣 · net / tax / gross.
orderOrderAmountBreakdownData必填訂單 · 折扣後 · net / tax / gross.
product_discountsOrderAmountBreakdownData必填商品 · 折扣 · net / tax / gross.
productsOrderAmountBreakdownData必填商品 · 折扣後 · net / tax / gross.
products_before_discountsOrderAmountBreakdownData必填商品 · 折扣前 · net / tax / gross.
shippingOrderAmountBreakdownData必填配送 · 折扣後 · net / tax / gross.
shipping_before_discountsOrderAmountBreakdownData必填配送 · 折扣前 · net / tax / gross.
shipping_discountsOrderAmountBreakdownData必填配送 · 折扣 · net / tax / gross.
附加欄位: 否
與產品或快照關聯的變體選項
shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · 架構 · 資料架構: 訂單
name字串必填對應上下文中的資源名稱。
value字串必填由所在架構描述的值。
附加欄位: 否
OrderDiscountData
OrderDiscountData · API 接收或傳回的資料欄位、類型和限制。
amountMoneyData必填含稅金額 · 商品 · 折扣.
campaign_id字串必填資源識別碼；請保留回傳的原值。
code字串 null必填穩定的機器可讀代碼。
kind字串必填由允許值說明的資料結構變體。
約束
enum["coupon", "promotion"]
name字串必填對應上下文中的資源名稱。
sequence整數 null選填套用順序; null.
shipping_amountMoneyDatanull選填含稅金額 · 配送 · 折扣; null.
version整數必填用於並行控制的資源版本。
附加欄位: 否
訂單中記錄的支付詳情
PaymentData · 架構 · 資料架構: 訂單
amountMoneyData必填payment.amount 是訂單總額。付款狀態無法確定已付、已退款或待付金額。
environment字串必填附加到記錄的環境資訊。
約束
enum["live", "sandbox"]
method_code字串 null必填配送或支付方式代碼。
method_name字串 null必填配送或支付方式名稱。
paid_at字串 null必填支付被標記為已付的日期和時間。
字串:format:"date-time"statusOrderPaymentStatus必填此操作接受的狀態。
updated_at字串必填最近更新時間。
format:"date-time"version整數必填用於並行控制的資源版本。
附加欄位: 否
更新 · 付款狀態 — 訂單 — 請求本文
PaymentStatusUpdate · API 接收或傳回的資料欄位、類型和限制。
expected_version整數必填寫入前讀取的版本；不匹配時拒絕更新。
minimum:0maximum:9223372036854775807reason字串必填記錄的變更原因。
minLength:1maxLength:500statusPaymentStatus必填此操作接受的狀態。
附加欄位: 否
此操作接受的狀態
PaymentStatus · 架構 · 資料架構: 訂單
字串約束
enum["unpaid", "paid", "failed", "refunded"]
附加欄位: 是
PickupPointAddressData
PickupPointAddressData · API 接收或傳回的資料欄位、類型和限制。
address_line_1字串必填第一行位址。
minLength:1maxLength:240city字串必填城市或地方。
minLength:1maxLength:160postal_code字串必填郵政編碼。
minLength:1maxLength:32
附加欄位: 否
PickupPointCoordinatesData
PickupPointCoordinatesData · API 接收或傳回的資料欄位、類型和限制。
latitude數值必填WGS84 φ (°)
minimum:-90.0maximum:90.0longitude數值必填WGS84 λ (°)
minimum:-180.0maximum:180.0
附加欄位: 否
PickupPointData
PickupPointData · API 接收或傳回的資料欄位、類型和限制。
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字串必填郵政編碼。
附加欄位: 否
PickupPointSummaryData
PickupPointSummaryData · API 接收或傳回的資料欄位、類型和限制。
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
附加欄位: 否
此資源記錄的客戶資訊
RequestCustomerData · 架構 · 資料架構: 訂單
email字串必填電子郵箱位址。
name字串必填對應上下文中的資源名稱。
附加欄位: 否
配送方式及相關資訊
ShippingData · 架構 · 資料架構: 訂單
amountMoneyData必填訂單中以 MoneyData 記錄的含稅配送金額。後續稅率變更不會改變此歷史金額。
datesDeliveryDatesData必填出貨及預計送達日期. 訂單列表和詳細資料均包含 delivery.dates。YYYY-MM-DD 格式的日期為計畫日期，不代表已出貨。目前日期優先；舊訂單使用已儲存的估計。已清除或未知的值為 null。詳細資料還包含所有訂單項目和商品圖片。
method_code字串 null必填配送或支付方式代碼。
method_name字串 null必填配送或支付方式名稱。
pickup_pointPickupPointSummaryDatanull必填取件地點
recipient_mode字串必填由允許值說明的資料結構變體。
約束
enum["full_address", "pickup_contact"]
附加欄位: 否
ShippingDetailData
ShippingDetailData · API 接收或傳回的資料欄位、類型和限制。
amountMoneyData必填訂單中以 MoneyData 記錄的含稅配送金額。後續稅率變更不會改變此歷史金額。
datesDeliveryDatesData必填出貨及預計送達日期. 訂單列表和詳細資料均包含 delivery.dates。YYYY-MM-DD 格式的日期為計畫日期，不代表已出貨。目前日期優先；舊訂單使用已儲存的估計。已清除或未知的值為 null。詳細資料還包含所有訂單項目和商品圖片。
discount_grossMoneyData必填含稅金額 · 折扣; 未知：null；已知零值：0.
discount_netMoneyDatanull必填未稅金額 · 折扣; 未知：null；已知零值：0.
discount_taxMoneyDatanull必填稅額 · 折扣; 未知：null；已知零值：0.
discounts陣列 <OrderDeliveryDiscountData> null必填配送 · 折扣; []: 0; null: 未知：null；已知零值：0.
grossMoneyData必填含稅金額 · 折扣後; 未知：null；已知零值：0.
method_code字串 null必填配送或支付方式代碼。
method_name字串 null必填配送或支付方式名稱。
netMoneyDatanull必填未稅金額 · 折扣後; 未知：null；已知零值：0.
original_grossMoneyData必填含稅金額 · 配送 · 折扣前; 未知：null；已知零值：0.
original_netMoneyDatanull必填未稅金額 · 配送 · 折扣前; 未知：null；已知零值：0.
original_taxMoneyDatanull必填稅額 · 配送 · 折扣前; 未知：null；已知零值：0.
pickup_pointDeliveryPickupPointDatanull必填取件地點
recipient_mode字串必填由允許值說明的資料結構變體。
約束
enum["full_address", "pickup_contact"]
taxMoneyDatanull必填稅額 · 折扣後; 未知：null；已知零值：0.
tax_category_id字串 null必填稅務類別識別碼 · 已儲存的訂單資料; null.
tax_category_name字串 null必填已儲存的稅務類別名稱; null.
tax_rate字串 null必填tax_rate · 已儲存的訂單資料: "0.23" = 23%; "0" ≠ null.
附加欄位: 否