订单创建

事件分组	事件标识
orders	orders/create

当订单被创建时触发。

请求头

Content-Type string required

字段值固定为 application/json; charset=utf-8。
X-Shopline-Topic string required

事件的唯一标识。

例子: orders/edited
X-Shopline-Hmac-Sha256 string required

该请求的签名。收到请求后，你需要对该签名进行验签以验证数据的真实性和完整性。

例子: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
X-Shopline-Shop-Domain string required

店铺的域名。

例子: example.myshopline.com
X-Shopline-Shop-Id string required

店铺 ID。

例子: 1610418123456
X-Shopline-Merchant-Id string required

商家 ID。

例子: 2000001234
X-Shopline-API-Version string required

API 版本号。

例子: v20250601
X-Shopline-Webhook-Id string required

该 Webhook 事件的 ID。

例子: b54557e48a5fbf7d70bcd043

请求体

adjust_price string

POS 交易场景下因金额四舍五入带来的差额金额，用店铺币种。
adjust_price_setobject

POS 交易场景下因金额四舍五入带来的差额金额，分别以买家币种和卖家币种展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
billing_addressobject

用于邮寄账单发票的地址。
address1 string

账单地址的第一行。通常是街道地址或邮政信箱编号等信息。
address2 string

账单地址的第二行。通常是公寓、套房或单元等信息。
city string

账单地址中的城市。
company string

账单收件人所在的公司名称。
country string

账单地址中的国家或区域。
country_code string

账单地址中国家或地区的二位码，遵循 ISO 3166-1 国际标准。
例子: US
first_name string

账单收件人的名。
last_name string

账单收件人的姓。
name string

账单收件人的全名。
phone string

账单收件人的手机号。
province string

账单地址中的省份。
province_code string

地址中省份或区域的编码，该编码为系统自动生成。
standard_province_code string

地址中省份或区域的编码，值为 ISO 3166-2 国际编码的后二位或三位，例如 RI 或 ENG。
zip string

账单地址的邮编信息。
browser_ip string

买家下单时的浏览器 IP 地址。
buyer_note string

买家留言。
cancel_reason string

卖家取消原因。
cancelled_at string

订单取消时间。格式：ISO 8601。
例子: 2024-08-31T02:20:26+08:00
cart_token string

购物车数据的唯一标识。
checkout_id string

弃单 ID。
checkout_token string

弃单数据的唯一标识，C 端用户发起结算，会生成弃单。
client_detailsobject

客户端详细信息。
browser_ip string

买家下单时的浏览器 IP 地址。
session_hash string

会员会话加密信息。
user_agent string

客户端代理。
uuid string

SHOPLINE 提供的客户客户端 ID。
companyobject

买家下单时买家所在的公司信息。
id string

公司 ID。
location_id string

地点 ID。
tax_registration_id string

税号信息。
contract_seq string

订阅合同号。
created_at string

订单创建时间。格式：ISO 8601。
例子: 2024-08-31T02:20:26+08:00
credit_limitobject

信用支付信息。
credit_limit_currency string

信用额度币种，与店铺币种相同。三位币种码，遵循 ISO 4217 国际标准。
is_credit_limit boolean

订单是否使用了信用支付。

true：有使用

false：未使用
outstanding_credit_limit string

占用的信用额度总和。初始和 total_credit_limit 相等，如果后续有类似还款操作，占用的额度则相应减少。
total_credit_limit string

使用的信用额度总和，即该笔订单用了多少信用额度支付。
currency string

订单交易币种。该字段值为三位币种码，遵循 ISO 4217 标准。
例子: USD
current_subtotal_price string

商品金额总和，为商品单价 * 数量，以店铺币种展示。
current_subtotal_price_setobject

商品金额总和，为商品单价 * 数量，分别以买家币种和店铺币种展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
current_total_discounts string

折扣金额总和，数值保留到小数点后两位，为营销优惠 + 人工折扣，以店铺币种展示。
current_total_discounts_setobject

折扣金额总和，数值保留到小数点后两位，为营销优惠 + 人工折扣，分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
current_total_duties_setobject

商品总关税，分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
current_total_price string

订单总额，以店铺币种金额展示。
current_total_price_setobject

订单总额，分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
current_total_tax string

税费金额总和，以店铺币种金额展示
current_total_tax_setobject

税费金额总和，分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
customerobject

买家信息。
addressesobject

买家地址信息。
address1 string

买家地址的第一行。通常是街道地址或邮政信箱编号等信息。
address2 string

买家地址的第二行。通常是公寓、套房或单元等信息。
city string

买家地址中的城市。
country string

买家地址中的国家或区域。
country_code string

买家地址中国家或地区的二位码，遵循 ISO 3166-1 国际标准。
例子: US
first_name string

买家地址中收件人的名。
last_name string

买家地址中收件人的姓。
name string

买家的姓名。
phone string

买家的手机号码。
province string

买家地址中的省份。
province_code string

地址中省份或区域的编码，该编码为系统自动生成。
zip string

买家地址的邮编信息。
area_code string

国家或地区的手机区号。
created_at string

买家信息创建时间。格式：ISO 8601。
例子: 2024-08-31T02:20:26+08:00
currency string

三位币种码，遵循 ISO 4217 国际标准。
email string

买家的邮箱地址。
first_name string

买家的名。
id string

买家 ID。
last_name string

买家的姓。
phone string

买家的手机号。
customer_locale string

买家语种编码 + 国家或地区码。语种编码遵循 ISO 639 标准。国家或地区码遵循 ISO 3166-1 标准。无法获取到语言信息时，仅返回国家或地区代码。
deduct_member_point_amount string

当前订单会员积分抵扣金额，以店铺币种展示。数值保留到小数点后两位。
deduct_member_point_amount_setobject

当前订单会员积分抵扣金额，分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
discount_applicationsobject[]

折扣信息。
allocation_method string

折扣的范围。有效枚举值包括：

across: 按照购买总数折扣

each: 按照单个商品分别折扣

示例：如一次购买三个相同的商品，折扣为 10 元。如果 allocation_method 为 across 代表三个一起减 10 元；如果 allocation_method 为 each 代表每个减 10 元。
code string

折扣码。
description string

自定义折扣的描述。
target_selection string

折扣范围。有效枚举值包括：

explicit：单个商品维度的折扣

entitled：整个商品行维度的折扣

all：若target_type为line_item，折扣适用于整单；若target_type为shipping_line，折扣适用于运费
target_type string

折扣应用的对象。有效枚举值包含：

line_item：作用在商品上的折扣

shipping_line：作用在运费上的折扣
title string

自动折扣的标题。
type string

折扣类型。有效枚举值包含：

manual：手动折扣

automatic：自动折扣

discount_code：折扣码
value string

折扣的具体值，以店铺币种展示。

当 value_type 为 fix_amount 时，此字段值表示特定的折扣金额。例如，如果值为 10 ，商店币种为人民币，则表示折扣为 10 元。

当 value_type 为 percentage 时，此字段值的值表示特定的折扣百分比。例如，10 表示订单金额的 10% 折扣。
value_type string

折扣值的类型。有效枚举值包含：

fix_amount：固定金额折扣。例如，如果 value 为 10，则意味着折扣为 10 元。

percentage：百分比折扣。例如，如果 value 为 10，则表示订单金额的 10% 折扣。
discount_codesobject[]

优惠码信息列表。
amount string

优惠金额，以店铺币种展示，数值保留到小数点后两位。
amount_setobject

折扣金额，分别以买家币种和店铺币种展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
code string

优惠码。
type string

优惠类型。有效枚举值包含：

减金额：全场满 100 元立减 10 元

打折：全场满 100 元打 9 折

免运费：满 3 件免运费

加价品：需要支付额外金额

任意N件优惠价：任意买 3 件商品，只需 99 元

A+B组合优惠价：同时买 A 商品和 B 商品，两件一起只需 88 元

赠品：购买制定商品赠送额外商品

固定售价：统一售价 29 元

最低价商品免费：买 3 件商品，最便宜的那件免费

打包价：多件商品组合以固定总价出售

第N件打折：第 2 件打 8 折

买x送y：满 2 件送 1 件

自定义：自定义折扣

废弃：返回的值为中文。该字段自 API 版本 v20250601 起已废弃。
draft_order_seq string

草稿单号。
email string

买家邮箱。
exist_subscription boolean
订单中是否存在订阅计划商品。
- true：存在
- false：不存在
financial_status string
订单付款状态。有效枚举值包含：
- unpaid：未支付
- authorized：已授权
- pending：处理中
- partially_paid：部分付款
- paid：已付款
- partially_refunded：部分退款
- refunded：已退款
fulfillment_status string
发货状态。有效枚举值包含：
- fulfilled：已发货
- partial：部分发货
- null：未发货
fulfillmentsobject[]

发货单信息列表。
created_at string

发货单创建时间。格式：ISO 8601。
例子: 2024-08-31T02:20:26+08:00
id string

发货单 ID。
line_itemsobject[]

商品列表。
attribute string

款式规格信息，以款式名称和规格值拼接展示。
例子: color - red
bundle_parent_variant_id string

套装子商品关联的父商品款式 ID。
fulfillable_quantity integer

商品剩余可发货数量。
fulfillment_quantity integer

商品已发货数量。
fulfillment_service string

物流商名称。
fulfillment_status string

商品发货状态。有效枚举值包含：

fulfilled：已发货

partial：部分发货

null：未发货

grams double

重量，单位：g。
id string

商品快照表的 ID，系统生成，与订单 ID 唯一确认一个商品。
image_url string

商品图片的 URL 地址。
is_bundle boolean

是否为套装商品。

true：套装商品

false：非套装商品

is_bundle_component boolean

是否为套装子商品。

true：子商品

false：非子商品

location_id string

本地配送地点编号或普通配送地点编号。
name string

SKU 标题，该字段值和 title 一致。
price string

商品售价，以店铺币种展示。数值保留到小数点后两位。
priceSetobject

商品售价，分别以店铺币种金额和买家币种金额展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
product_id string

款式对应商品的唯一标识 ID。
quantity integer

订单中的商品数量。
requires_shipping boolean

商品是否需要发货。

true：需要发货

false：不需要发货

sku string

商品 SKU。
tax_linesobject[]

税费明细列表。
price string

税费，以店铺币种展示。数值保留到小数点后两位。
price_setobject

税费，分别以买家币种和店铺币种展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
rate double

税率，以小数形式表示，数值保留到小数点后四位。如果税率为2%，该值为0.0200。该信息只做展示作用。
title string

税费说明标题。
taxable boolean

该商品是否需要收税。

true：需要收税

false：不需要收税

title string

商品标题。
variant_id string

款式的唯一标识 ID。
variant_title string

商品款式值，多个以 / 分割。
vendor string

供应商。
order_id string

订单号。
shipment_status string

发货单物流状态。有效枚举值包含：

out_for_delivery：正在配送

delivered：已送达

faliure：配送失败

picked_up：已取货
status string

发货单状态。有效枚举值包含：

success：已发货

cancelled：已取消
tracking_company string

物流公司名称。

废弃：该字段自 API 版本 v20250601 起已废弃。查看 tracking_info_list 字段。
tracking_info_listobject[]

物流追踪信息列表。
tracking_company string

物流服务商。
tracking_number string

物流单号。
tracking_url string

物流公司的域名。
tracking_number string

第三方物流单号。

废弃：该字段自 API 版本 v20250601 起已废弃。查看 tracking_info_list 字段。
tracking_url string

物流公司的域名。

废弃：该字段自 API 版本 v20250601 起已废弃。查看 tracking_info_list 字段。
updated_at string

订单包裹更新时间。格式：ISO 8601。
例子: 2024-08-31T02:20:26+08:00
hidden_order boolean
订单是否已归档。有效枚举值包含：
- true：已归档订单
- false：未归档订单
id string

订单号，系统自定义编号。
landing_site string

记录完整的订单归因落地页的链接。
line_itemsobject[]

订单商品快照信息列表。
attribute string

款式规格信息，以款式名称和规格值拼接展示。
例子: color - red
bundle_parent_variant_id string

套装子商品关联的父商品款式 ID。
discount_allocationsobject[]

营销折扣金额，分别以买家币种金额和店铺币种金额展示。
amount string

营销折扣金额，数值保留到小数点后两位。
amount_setobject

折扣金额，分别以买家币种和店铺币种展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
discount_application_index integer

标明商品行应用的折扣在 discount_applications 中的位置。
dutiesobject[]

关税信息。
country_code_of_origin string

原产地或发货地的国家或地区代码。遵循 ISO 3166-1 国际标准。
例子: US
harmonized_system_code string

海关编码，用于在国际贸易中对产品进行分类。
id string

关税编号。
priceobject

关税金额，分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
tax_linesobject[]

税费信息列表。
price_setobject

税费金额，分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
rate double

税率，以小数形式表示，数值保留到小数点后四位。如果税率为2%，该值为0.0200。该信息只做展示作用。
rate_percentage double

税率，以百分比数值形式表示，数值保留到小数点后两位。如果税率为2%，该值为2.00。该信息只做展示作用。
title string

税费说明标题。
fulfillable_quantity integer

剩余可发货数量。
fulfillment_service string

物流商名称。
fulfillment_status string

商品发货状态。有效枚举值包含：

fulfilled：已发货

partial：部分发货

null：未发货
giftCard boolean

该商品是否为礼品卡商品。

true：是礼品卡商品

false：不是礼品卡商品
grams double

重量，单位：g。
id string

商品快照表的 ID，系统生成，与订单 ID 唯一确认一个商品。
image_url string

商品图片的 URL 地址。
is_bundle boolean

是否为套装商品。

true：套装商品

false：非套装商品
is_bundle_component boolean

是否为套装子商品。

true：子商品

false：非子商品
location_id string

本地配送地点编号或普通配送地点编号。
name string

SKU 标题，该字段值和 title 一致。
price string

商品售价，以店铺币种金额展示，数值保留到小数点后两位。
price_setobject

商品售价，分别以店铺币种金额和买家币种金额展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
product_id string

款式对应商品的唯一标识 ID。
propertiesobject[]

商品定制信息列表。
additional string

定制商品附加字段，比如当 name 为 文字，additional 可以附加文字的字号、字体、颜色等。
name string

自定义属性名称。
type string

定制信息类型。有效枚举值包含：

text：字符类型

picture：图片类型

link：链接类型

urls array

URL 列表。如果 type 是 picture，可通过 urls 获取缩略图，如果 type 是 link，那么超链接为 urls 的第一个。
value string

自定义属性值。
quantity integer

订单中的商品数量。
requires_shipping boolean

商品是否需要发货。

true：需要发货

false：不需要发货
sku string

商品 SKU。
tags string

商品标签，多个以逗号隔开。
tax_linesobject[]

税费明细列表。
price string

税费，以店铺币种展示。数值保留到小数点后两位。
price_setobject

税费，分别以买家币种和店铺币种展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
rate double

税率，以小数形式表示，数值保留到小数点后四位。如果税率为2%，该值为0.0200。该信息只做展示作用。
title string

税费说明标题。
type string

税费类型。有效枚举值包含：

product_tax: 商品税

shipping_tax: 运费税
taxable boolean

该商品是否需要收税。

true：需要收税

false：不需要收税
title string

商品标题。
variant_id string

款式的唯一标识 ID。
variant_title string

商品属性值，多个以 / 分割。
vendor string

供应商。
locationsobject[]

到店取货地点地址信息列表。
location_id string

取货地点唯一编号。
name string

取货地址名称。
type string

地点类型。有效枚举值包含：

posLocation：POS 渠道创建该订单的门店地点，后续将废弃。建议使用 pos_location_id。

pickupLocation：当订单的配送方式为自提时，自提的门店地点。

productLocation：订单中商品的库存地点，后续将废弃。建议使用商品行中的 location_id 信息。
name string

商家自定义的订单号，从 1001 开始，可以设置前缀。
note string

商家备注内容。
note_attributesobject[]

商家备注日志。
create_time string

备注创建时间。格式：ISO 8601。
例子: 2024-08-31T02:20:26+08:00
name string

卖家标识，表明备注来源。
value string

备注内容。
order_at string

订单成单时间。格式：ISO 8601。
例子: 2024-08-31T02:20:26+08:00
order_source string

订单来源渠道的 handle。handle 为语义化标识符。
order_status_url string

订单状态页 URL。
payment_detailsobject[]

支付单信息列表。
create_time string

支付单创建时间。格式：ISO 8601。
例子: 2024-08-31T02:20:26+08:00
pay_amount double

支付金额，以店铺币种金额展示。数值保留到小数点后两位。
pay_channel_deal_id string

外部渠道支付流水号。
pay_seq string

支付单号。
pay_status string

支付单状态。有效枚举值包含：

unpaid：未支付

pending：支付中

risking：风控中

paid：已支付

paid_overtime：支付超时

paid_failed：支付失败
payment_channel string

支付渠道编码。
payment_method string

支付方式。
processed_at string

支付单创建时间。格式：ISO 8601。
例子: 2024-08-31T02:20:26+08:00
status_code string

支付网关标准状态码。
status_msg string

支付网关状态码信息。
payment_gateway_names array
付款方式列表。有效枚举值包含：
- SLpayments
- Paypal（PayPal支付）
- Oceanpay（钱海支付）
- TwoCheckout
- AsiaBill
- Stripe
- Pacypay
- WorldPay
- COD（货到付款）
- CUSTOM（自定义）
- adjustPay（资金调整）
- Xendit（xendit 信用卡）
- XenditOther
payment_termsobject

支付条款和付款信息。
created_at string

支付条款创建时间。

格式：ISO 8601。
例子: 2024-08-31T02:20:26+08:00
due_in_days integer

在选定的付款条件模板中定义的发票日期和到期日之间的天数。当 payment_terms_type 类型为 NET 时提供。
id string

支付条款的唯一识别 ID。
overdue boolean

支付条款是否超时。

true: 超时

false: 未超时
payment_schedulesobject[]

与付款条件相关联的一组时间表。
completed_at string

记录支付完成的日期和时间。
due_at string

支付条款到期的日期和时间。
当 payment_terms_type 值为 FIXED 时，due_at 必有值。
当 payment_terms_type 值为 NET 时，due_at 的值为 issued_at 加 due_in_days。
当 payment_terms_type 值为 FULFILLMENT 时，仅在订单发货时有值。
issued_at string

支付条款生效的日期和时间。
当 payment_terms_type 值为 FIXED 时，如果 issued_at 为空，则 issued_at 等于 due_at。
当 payment_terms_type 值为 NET 时，issued_at 一定有值。
当 payment_terms_type 值为 FULFILLMENT 时，仅在订单发货时有值。
当 payment_terms_type 值为 RECEIPT 时，仅在发送账单时有值。
例子: 2024-08-31T02:20:26+08:00
payment_terms_name string

付款条件模板的名称。
payment_terms_type string

付款条件模板类型。有效枚举值：

FIXED: 指定日期前全额付款

FULFILLMENT: 订单发货时全额付款

RECEIPT: 发送账单时全额付款

NET: 净付款
updated_at string

支付条款的更新时间。

格式：ISO 8601。
例子: 2024-08-31T02:20:26+08:00
phone string

买家的手机号。
po_number string

B2B 场景在订单上记录的采购订单号。
pos_location_id string

POS 交易地点 ID。
presentment_currency string

买家侧币种，同卖家侧币种。三位币种码，遵循 ISO 4217 国际标准。
例子: USD
processed_at string

成单时间。格式：ISO 8601。
例子: 2024-08-31T02:20:26+08:00
processed_user_id string

订单创建者的 ID。
referring_site string

归因 URL，用于记录买家如何被重定向到在线商店。
refundsobject[]

退款列表。
created_at string

退款单创建时间。格式：ISO 8601。
例子: 2024-08-31T02:20:26+08:00
id string

退款 ID。
note string

卖家退款备注。
order_id string

订单号。
processed_at string

退款发起时间。格式：ISO 8601。
例子: 2024-08-31T02:20:26+08:00
user_id string

买家 ID。
serivce string
运输方式类型。有效枚举值包含：
- Pickup：到店取货
- null：其他运输方式
shipping_addressobject

收货地址。
address1 string

地址的第一行。通常是街道地址或邮政信箱编号等信息。
address2 string

地址的第二行。通常是公寓、套房或单元等信息。
city string

地址中的城市。
company string

收件人所在的公司名称。
country string

地址中的国家或区域。
country_code string

地址中国家或区域的二位码，遵循 ISO 3166-1 国际标准的二位国家或区域码。
delivery_store_code string

门店编码。
delivery_store_name string

门店名称。
district string

收货地址中的行政区名称。
district_code string

收货地址中区的编码，自定义编号。
first_name string

收件人的名。
last_name string

收件人的姓。
latitude string

地址所在的纬度。
longitude string

地址所在的经度。
name string

买家的全名。
phone string

收件人的手机号码。
province string

收货地址中州或省的名称。
province_code string

地址中省份或区域的编码，该编码为系统自动生成。
standard_province_code string

地址中省份或区域的编码，值为 ISO 3166-2 国际编码的后二位或三位，例如 RI 或 ENG。
zip string

地址的邮编信息。
shipping_linesobject[]

运费列表。
code string

只有本地配送运费方案有值，返回 Local delivery 。
discount_allocationsobject[]

营销折扣金额，分别以买家币种金额和店铺币种金额展示。
amount string

折扣金额，以店铺币种展示。数值保留到小数点后两位。
amount_setobject

折扣金额，分别以买家币种和店铺币种展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
discount_application_index integer

标明商品行应用的折扣在 discount_applications 中的位置。
discounted_price string

折扣金额，以店铺币种展示。数值保留到小数点后两位。
discounted_price_setobject

折扣金额，分别以买家币种和店铺币种展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
phone string

买家的手机号。
price string

运费，以店铺币种展示。数值保留到小数点后两位。
price_setobject

运费金额，分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shipping_price string

原运费金额值，非折扣后金额，以店铺币种展示。数值保留到小数点后两位。
source string

物流承运商类型。有效枚举值包含：

Shipper：Shipper 物流

Oneship：Oneship 物流

Api：通过开放能力添加的承运商的物流

null：系统物流或自定义物流
tax_linesobject[]

税费信息列表。
price string

税费，以店铺币种展示。数值保留到小数点后两位。
price_setobject

税费，分别以买家币种和店铺币种展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
rate double

税率，以小数形式表示，数值保留到小数点后四位。如果税率为2%，该值为0.0200。该信息只做展示作用。
title string

税费名称。
title string

物流公司名称。
source_identifier string

客户点击链接访问商店时的营销推荐代码。支持以下 URL 参数：ref、resource 或 r。例如，如果 URL 是 myshopline.com/products/slide?ref=22dd9dctg 则该值为 22dd9dctg。
source_name string
表示查询订单的行为是由哪个应用触发的。有效枚举值包含：
- sales_plugin_of：行为来自营销系统的分销插件
- member_plugin_referral：行为来自会员系统的推荐插件
source_url string

归因 URL，用于记录买家如何被重定向到在线商店。
status string
订单状态。有效枚举值包含：
- open：订单处理中
- cancelled：订单已取消
store_id string

店铺 ID。
subtotal_price string

商品折后价总和，数值保留到小数点后两位，为商品总价 - 营销优惠 - 自定义折扣，以店铺币种展示。
subtotal_price_setobject

商品折后价总和，分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
tags string

订单标签。
tax_linesobject[]

税费信息列表。
price string

税费，以店铺币种展示。数值保留到小数点后两位。
price_setobject

税费，分别以买家币种和店铺币种展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
rate double

税率，以小数形式表示，数值保留到小数点后四位。如果税率为2%，该值为0.0200。该信息只做展示作用。
title string

税费说明标题。
tax_number string

税号。
tax_type string
订单的税费类型。有效枚举值包含：
- product_tax：商品税
- shipping_tax：运费税
taxes_included boolean
该订单是否包含税费金额。
- true：包含税费金额
- false：不包含税费金额
total_discounts string

订单折扣总和，为营销折扣 + 自定义折扣，数值保留到小数点后两位，以店铺币种金额展示。

废弃：该字段自 API 版本 v20210901 起已废弃。
例子: 3.25
total_discounts_setobject

订单折扣总和，为营销折扣 + 自定义折扣，分别以店铺币种金额和买家币种金额展示。

废弃：该字段自 API 版本 v20210901 起已废弃。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
total_line_items_price string

商品原价总和，数值保留到小数点后两位，以店铺币种金额展示。
total_line_items_price_setobject

商品原价总和，分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
total_outstanding string

未付款金额总额，数值保留到小数点后两位，以店铺币种金额展示。
total_outstanding_setobject

未付款金额，分别以店铺币种金额和买家币种金额展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
total_shipping_price_setobject

订单运费总和，分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
total_tax string

税费总额，数值保留到小数点后两位，以店铺币种金额展示。
total_tax_setobject

税费金额总和，分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
total_tip_received string

小费，数值保留到小数点后两位，以店铺币种金额展示。
total_tip_received_setobject

小费，分别以店铺币种金额和买家币种金额展示。
presentment_moneyobject

展示给买家的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
shop_moneyobject

商家侧记录的金额。
amount string

金额值，保留到小数点后两位。
currency_code string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
total_weight double

商品总重量，单位：g。
updated_at string

订单更新时间。格式：ISO 8601。
例子: 2024-08-31T02:20:26+08:00
user_id string

买家 ID。
utm_parameters string

广告业务专用的参数，用于广告的归因计算。

状态码

收到 SHOPLINE 发送的 Webhook 通知后，你需要按照如下 SHOPLINE 要求的格式进行响应。

HTTP/1.1 200 OK

关于如何订阅 Webhooks 及更多 Webhook 响应规则说明，请参考 Webhook 概述。

这篇文章对你有帮助吗？

SHOPLINE

条款协议