获取 — 订单
读取“订单”的数据。结果取决于此操作的参数。
GET/api/v1/orders/{order_id}
- 身份验证
Bearer- 最低套餐
- BASIC
- 所需权限
orders.order:read
代码示例
请求示例
cURL
: "${SHOPENTLY_SHOP_URL:?}"
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request GET \
--header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/orders/example
PHP
<?php
declare(strict_types=1);
$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
isset($origin['query']) || isset($origin['fragment'])) {
throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
throw new RuntimeException('Invalid credential');
}
$headers = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/orders/example');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
CURLOPT_SSL_VERIFYPEER => true,
CURLOPT_SSL_VERIFYHOST => 2,
CURLOPT_CONNECTTIMEOUT => 5,
CURLOPT_TIMEOUT => 30,
CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
if (str_contains($line, ':')) {
[$name, $value] = explode(':', $line, 2);
$responseHeaders[strtolower(trim($name))] = trim($value);
}
return strlen($line);
},
]);
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
throw new RuntimeException('HTTP ' . $status . '; request_id=' .
($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;
Python
from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit
import requests # python -m pip install requests
base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
raise ValueError("Invalid credential")
headers = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
if body is not None:
headers["Content-Type"] = "application/json"
with ExitStack() as stack:
session = stack.enter_context(requests.Session())
files = None
if False:
image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
if os.fstat(image.fileno()).st_size > 5242880:
raise ValueError("Image exceeds 5 MiB")
files = {"file": ("article.png", image, "image/png")}
response = session.request(
'GET', base_url + '/api/v1/orders/example', headers=headers,
data=body.encode("utf-8") if body is not None else None, files=files,
timeout=(5, 30), allow_redirects=False,
)
if not 200 <= response.status_code < 300:
raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
if False:
if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
raise ValueError("Unexpected image response")
with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
output.write(response.content)
else:
result = response.json() if response.content else None
print(json.dumps(result, ensure_ascii=False, indent=2))
响应示例 200
{
"data": {
"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
}
}
}
},
"meta": {
"request_id": "example-request"
}
}
工作原理
- 集合提供订单摘要,以及订单号、状态、支付状态和创建时间筛选。
- 订单列表和详情均包含 delivery.dates。YYYY-MM-DD 格式的日期为计划日期,不代表已发货。当前日期优先;旧订单使用已保存的估计。已清除或未知的值为 null。详情还包含所有订单项和商品图片。
- 从 /api/v1/order-statuses 获取有效状态标识符。
- 订单状态和支付状态使用不同的 PATCH 端点及权限。
- 修改记录中的支付状态不会从银行卡扣款,也不会通过支付服务商发起退款。
订单 · 合计
金额和税率取自已保存的订单,包括订单项更正。缺失的历史数据为 null,不会用当前商品目录的税率补齐。金额始终保持为十进制字符串。
列表返回摘要。对每个结果获取 GET /api/v1/orders/{order_id},以导出完整的金额明细。GET 重试次数有限,并遵守 Retry-After。按创建日期导出不会同步之后的更正。
- tax_country_code · 征税国家 · 已保存的订单数据 · ISO 3166-1 alpha-2; null.
- lines[].unit_* · 单件 · 折扣前; lines[].original_total_* · 折扣前; lines[].total_* · 折扣后.
- lines[].discount_* · 折扣; manual_discount · 手动折扣; percentage "10" = 10%.
- delivery.net / tax / gross · 折扣后; delivery.original_* · 折扣前; delivery.discount_* · 折扣.
- tax_rate: "0.23" = 23%; "0" ≠ null. 未知:null;已知零值:0.
- totals · 合计; tax_breakdown.groups · 税务分组; 未分配税额 = order.tax − Σ groups.tax; ±.
payment.amount 是订单总额。付款状态不能确定已付、已退款或待付金额。
参数
路径参数
order_id字符串必填相关订单标识符。
约束
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
此操作不接受 JSON 请求体。
响应
响应 200
完整模型: ApiResponse_OrderDetailData_
dataOrderDetailData必填成功响应的数据。
字段 ·
datacreated_at字符串必填创建时间。
format:"date-time"customerCustomerData必填此资源记录的客户信息。
字段 ·
customeremail字符串必填电子邮箱地址。
first_name字符串 null必填名。
last_name字符串 null必填姓。
phone字符串 null必填电话号码。
deliveryShippingDetailData必填配送方式及相关信息。
字段 ·
deliveryamountMoneyData必填以 JSON 字符串编码的十进制金额;仅在允许时使用 null。
datesDeliveryDatesData必填发货及预计送达日期
discount_grossMoneyData必填含税金额 · 折扣; 未知:null;已知零值:0.
discount_netMoneyDatanull必填未税金额 · 折扣; 未知:null;已知零值:0.
discount_taxMoneyDatanull必填税额 · 折扣; 未知:null;已知零值:0.
discounts数组 <OrderDeliveryDiscountData> null必填折扣
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必填税务信息。
tax_category_id字符串 null必填税务类别标识符。
tax_category_name字符串 null必填已保存的税务类别名称; null.
tax_rate字符串 null必填tax_rate · 已保存的订单数据: "0.23" = 23%; "0" ≠ null.
discount_amountMoneyData必填以 JSON 字符串编码的十进制金额;仅在允许时使用 null。
字段 ·
discount_amountamount字符串必填以 JSON 字符串编码的十进制金额;仅在允许时使用 null。
currency字符串必填金额的币种代码。
约束
pattern"^[A-Z]{3}$"
minor_units整数必填币种使用的小数位数。
minimum:0maximum:4
discounts数组 <OrderDiscountData> 必填折扣
字段 ·
discountsid字符串必填资源标识符;请保留返回的原值。
invoiceInvoiceDatanull必填发票信息。
字段 ·
invoiceinvoice_requested布尔值必填是否要求开具发票。
lifecycle_stateOrderLifecycleState必填业务生命周期状态。
lines数组 <OrderLineData> 必填订单行快照。
字段 ·
lineslocale字符串必填本次请求选择的语言。
market_id字符串必填上下文端点返回的市场标识符。
number字符串必填面向用户的订单号或申请编号。
paymentPaymentData必填订单中记录的支付详情。
字段 ·
paymentamountMoneyData必填以 JSON 字符串编码的十进制金额;仅在允许时使用 null。
environment字符串必填附加到记录的环境信息。
约束
enum["live", "sandbox"]
method_code字符串 null必填配送或支付方式代码。
method_name字符串 null必填配送或支付方式名称。
paid_at字符串 null必填支付被标记为已付的日期和时间。
字符串:format:"date-time"statusOrderPaymentStatus必填此操作接受的状态。
updated_at字符串必填最近更新时间。
format:"date-time"version整数必填用于并发控制的资源版本。
pickup_pointPickupPointDatanull必填取件地点
字段 ·
pickup_pointprices_include_tax布尔值必填列出的价格是否含税。
shipping_addressAddressDatanull必填收货地址。
字段 ·
shipping_addressshipping_discount_amountMoneyData必填以 JSON 字符串编码的十进制金额;仅在允许时使用 null。
字段 ·
shipping_discount_amountamount字符串必填以 JSON 字符串编码的十进制金额;仅在允许时使用 null。
currency字符串必填金额的币种代码。
约束
pattern"^[A-Z]{3}$"
minor_units整数必填币种使用的小数位数。
minimum:0maximum:4
statusOrderStatusData必填此操作接受的状态。
字段 ·
statusid字符串必填资源标识符;请保留返回的原值。
name字符串必填对应上下文中的资源名称。
updated_at字符串必填最近更新时间。
format:"date-time"version整数必填用于并发控制的资源版本。
subtotalMoneyData必填加入响应中所示附加组成部分之前的金额。
字段 ·
subtotalamount字符串必填以 JSON 字符串编码的十进制金额;仅在允许时使用 null。
currency字符串必填金额的币种代码。
约束
pattern"^[A-Z]{3}$"
minor_units整数必填币种使用的小数位数。
minimum:0maximum:4
taxMoneyData必填税务信息。
字段 ·
taxamount字符串必填以 JSON 字符串编码的十进制金额;仅在允许时使用 null。
currency字符串必填金额的币种代码。
约束
pattern"^[A-Z]{3}$"
minor_units整数必填币种使用的小数位数。
minimum:0maximum:4
tax_breakdownOrderTaxBreakdownData必填税务分组 · source + tax_rate; unallocated_tax.
字段 ·
tax_breakdowngroups数组 <OrderTaxGroupData> 必填税务分组 · source + tax_rate; 未知:null;已知零值:0.
unallocated_taxMoneyData必填未分配税额 = order.tax − Σ groups.tax; ±.
tax_country_code字符串 null必填征税国家 · 已保存的订单数据 · ISO 3166-1 alpha-2; null.
totalMoneyData必填总金额。
字段 ·
totalamount字符串必填以 JSON 字符串编码的十进制金额;仅在允许时使用 null。
currency字符串必填金额的币种代码。
约束
pattern"^[A-Z]{3}$"
minor_units整数必填币种使用的小数位数。
minimum:0maximum:4
totalsOrderTotalsData必填合计 · net / tax / gross; 折扣前 / 折扣后.
字段 ·
totalsbefore_discountsOrderAmountBreakdownData必填订单 · 折扣前 · net / tax / gross.
discountsOrderAmountBreakdownData必填折扣
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.
metaContextPageMetaContextMetaPageMetaRequestMeta必填响应元数据。
字段 ·
metalocale字符串必填本次请求选择的语言。
market_code字符串必填上下文端点返回的市场代码。
market_id字符串必填上下文端点返回的市场标识符。
paginationPagination必填游标分页元数据。
request_id字符串必填申请标识符;在响应元数据中表示 HTTP 请求标识符。
minLength:1maxLength:100
locale字符串必填本次请求选择的语言。
market_code字符串必填上下文端点返回的市场代码。
market_id字符串必填上下文端点返回的市场标识符。
request_id字符串必填申请标识符;在响应元数据中表示 HTTP 请求标识符。
minLength:1maxLength:100
paginationPagination必填游标分页元数据。
request_id字符串必填申请标识符;在响应元数据中表示 HTTP 请求标识符。
minLength:1maxLength:100
HTTP 状态
200- 请求成功 架构
400- 无效请求
401- 需要身份验证
403- 权限不足
404- 未找到资源
409- 版本冲突
422- 验证失败
429- 超出请求限制
其他 HTTP 状态 (7)
405- 不允许的方法
413- 请求过大
415- 不支持的格式
500- 服务器错误
502- API 网关错误
503- 服务不可用
504- 网关超时
错误目录: ErrorResponse
请求头与响应头
401
WWW-Authenticate字符串可选服务器要求的身份验证方案。
405
Allow字符串可选此资源支持的 HTTP 方法。
429, 503
Retry-After整数可选重试前最少等待的秒数。
minimum:0