数据架构
收货地址
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.
附加字段: 否