订单全部发货
| 事件分组 | 事件标识 |
|---|---|
| orders | orders/fulfilled |
当订单商品全部发货时触发。
请求头
- 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 requiredAPI 版本号。例子:
v20250601 - X-Shopline-Webhook-Id string required该 Webhook 事件的 ID。例子:
b54557e48a5fbf7d70bcd043
请求体
- adjust_price stringPOS 交易场景下因金额四舍五入带来的差额金额,用店铺币种。
billing_addressobject
用于邮寄账单发票的地址。address1 string账单地址的第一行。通常是街道地址或邮政信箱编号等信息。address2 string账单地址的第二行。通常是公寓、套房或单元等信息。city string账单地 址中的城市。company string账单收件人所在的公司名称。country string账单地址中的国家或区域。first_name string账单收件人的名。last_name string账单收件人的姓。name string账单收件人的全名。phone string账单收件人的手机号码。province string账单地址中的省份。province_code string地址中省份或区域的编码,该编码为系统自动生成。standard_province_code stringzip string账单地址的邮编信息。- browser_ip string买家下单时的浏览器 IP 地址。
- cancel_reason string卖家取消原因。
- checkout_id string弃单 ID。
client_detailsobject
客户端详细信息。browser_ip string买家下单时的浏览器 IP 地址。session_hash string会员会话加密信息。例子:c2c4a58186b9d96395d7e6b5c2969577user_agent string客户端代理。例子:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Sauuid stringSHOPLINE 提供的客户客户端 ID。- current_subtotal_price string商品金额总和,为商品单价 * 数量,以店铺币种展示。
- current_total_discounts string折扣金额总和,数值保留到小数点后两位,为营销优惠 + 人工折扣,以店铺币种展示。
current_total_discounts_setobject
折扣金额总和,数值保留到小数点后两位,为营销优惠 + 人工折扣,分别以买家币种金额和店铺币种金额展示。- current_total_price string订单总额,以店铺币种金额展示。
- current_total_tax string税费金额总和,以店铺币种金额展示。
customerobject
买家信息。addressesobject
买家地址信息。address1 string买家地址的第一行。通常是街道地址或邮政信箱编号等信息。address2 string买家地址的第二行。通常是公寓、套房或单元等信息。city string买家地址中的城市。country string买家地址中的国家或区域。first_name string买家地址中买家的名。last_name string买家地址中买家的姓。name string买家地址中买家的全名。phone string买家地址中买家的手机号码。province string买家地址中的省份。province_code string地址中省份或区域的编码,该编码为系统自动生成。zip string地址的邮编信息。area_code string国家或地区的手机区号。例子:+86email 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当前订单会员积分抵扣金额,以店铺币种展示。数值保留到小数点后两位。
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优惠金额,以店铺币种展示,数值保留到小数点后两位。code string优惠码。type string优惠类型。废弃: 该字段自 API 版本 v20250601 起已废弃。- email string买家邮箱。
- financial_status string订单付款状态。有效枚举值包含:
unpaid:未支付authorized:已授权pending:处理中partially_paid:部分付款paid:已付款partially_refunded:部分退款refunded:已退款
- fulfillment_status string发货状态。有效枚举值包含:
unshipped:未发货partial:部分发货shipped:已发货
fulfillmentsobject[]
发货单信息列表。id string发货单 ID。line_itemsobject[]
发货单的商品列表。attribute string款式规格信息,以款式名称和规格值拼接展示。例子:color - redfulfillable_quantity integer商品剩余可发货数量。fulfillment_quantity integer已发货数量。fulfillment_service string物流商名称。fulfillment_status string发货状态。有效枚举值包含:unshipped:未发货partial:部分发货shipped:已发货
grams double重量,单位:g。id string商品快照表的 ID,系统生成,与订单 ID 唯一确认一个商品。image_url string商品图片的 URL 地址。location_id string取货地点唯一编号。name stringSKU 标题,该字段值和title一致。price string商品售价,以店铺币种展示。数值保留到小数点后两位。product_id string款式对应商品的唯一标识 ID。quantity integer商品数量。requires_shipping boolean该商品是否需要发货。true:需要发货false:不需要发货
sku string商品 SKU。例子:test-002tax_linesobject[]
税费信息列表。price string税费金额。商品实际收税以此字段金额为准。rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。taxable boolean该商品是否需要收税。true:需要收税false:不需要收税
title string商品标题,用于展示给买家。variant_id string款式的唯一标识 ID。variant_title string商品属性值。vendor string供应商。name 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字段查看相关信息。- id string订单号,系统自定义编号。
line_itemsobject[]
订单商品快照信息列表。attribute string款式规格信息,以款式名称和规格值拼接展示。例子:color - reddiscount_allocationsobject[]
营销折扣金额,分别以买家币种金额和店铺币种金额展示。amount string营销折扣金额,数值 保留到小数点后两位。discount_application_index integer标明商品行应用的折扣在discount_applications中的位置。dutiesobject[]
关税信息。country_code_of_origin string原产地或发货地的国家或地区代码。遵循 ISO 3166-1 国际标准。harmonized_system_code string海关编码,用于在国际贸易中对产品进行分类。id string关税编号。tax_linesobject[]
税费信息列表。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:未发货
gift_card boolean是否为礼品卡商品。true:是礼品卡商品false:不是礼品卡商品
grams double重量,单位:g。id string商品快照表的 ID,系统生成,与订单 ID 唯一确认一个商品。image_url string商品图片的 URL 地址。location_id string本地配送地点编号或普通配送地点编号。name stringSKU 标题,该字段值和title一致。price string商品售价,以店铺币种展示。数值保留到小数点后两位。product_id string款式对应商品的唯一标识 ID。propertiesobject[]
商品定制信息列表。additional string定制商品附加字段,比如当name为文字,additional可以附加文字的字号、字体、颜色等。name string自定义属性名称。type string定制信息类型。有效枚举值包含:text:字符类型picture:图片类型link:链接类型
urls arrayURL 列表。如果type是picture,可通过urls获取缩略图,如果type是link,那么超链接为urls的第一个。例子:["https://www.urls.com"]value string自定义属性值。quantity integer商品数量。requires_shipping boolean商品是否需要发货。true:需要发货false:不需要发货
sku string商品 SKU。例子:18056761559987524812644011tags string商品标签,多个逗号隔开。tax_linesobject[]
税费明细列表。price string税费,以店铺币种展示。数值保留到小数点后两位。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[]
商家备注内容。name string卖家标识,表明备注来源。value string备注内容。- order_source string订单来源渠道的 handle。handle 为语义化标识符。
- order_status_url string订单状态页 URL。
payment_detailsobject[]
支付单信息列表。pay_amount double支付金额,以店铺币种金额展示。数值保留到小数点后两位。pay_channel_deal_id string外部渠道支付流水号。pay_seq string支付单号。pay_status string支付单状态。有效枚举值包含:unpaid:未支付pending:支付中risking:风控中paid:已支付paid_overtime:支付超时paid_failed:支付失败
- payment_gateway_names array付款方式列表。有效枚举值包含:
SLpaymentsPaypal(PayPal支付)Oceanpay(钱海支付)TwoCheckoutAsiaBillStripePacypayWorldPayCOD(货到付款)CUSTOM(自定义)adjustPay(资金调整)Xendit(xendit 信用卡)XenditOther
- phone string买家的手机号。
- pos_location_id stringPOS 交易地点 ID。
- processed_user_id string订单创建者的 ID。
shipping_addressobject
收货地址。address1 string地址的第一行。通常是街道地址或邮政信箱编号等信息。address2 string地址的第二行。通常是公寓、套房或单元等信息。city string地址中的城市。company string收件人的公司名称。country string地址中的国家或区域。first_name string收件人的名。last_name string收件人的姓。latitude string地址所在的纬度。longitude string地址所在的经度。name string收件人的全名。phone string收件人的手机号码。province string地址中的省份。province_code string地址中省份或区域的编码,该编码为系统自动生成。standard_province_code stringzip string地址的邮编信息。shipping_linesobject[]
运费列表。code string只有本地配送运费方案有值,返回Local delivery。discount_allocationsobject[]
折扣明细列表。amount string折扣金额,以店铺币种展示。数值保留到小数点后两位。discount_application_index integer标明商品行应用的折扣在discount_applications中的位置。discounted_price string折扣金额,以店铺币种展示。数值保留到小数点后两位。phone string买家的手机号。price string运费,以店铺币种展示。数值保留到小数点后两位。shipping_price string原运费金额值,非折扣后金额,以店铺币种展示。数值保留到小数点后两位。source string物流承运商类型。有效枚举值包含:Shipper:Shipper 物流Oneship:Oneship 物流Api:通过开放能力添加的承运商的物流null:系统物流或自定义物流
tax_linesobject[]
税费信息列表。price string税费,以店铺币种展示。数值保留到小数点后两位。rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费 说明标题。该信息只做展示作用。title string物流公司名称。- store_id string店铺 ID。
- subtotal_price string商品折后价总和,为商品总价 - 营销优惠 - 自定义折扣,以店铺币种展示。
- tags string订单标签。
tax_linesobject[]
税费明细列表。price string税费,以店铺币种展示。数值保留到小数点后两位。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 起已废弃。- total_line_items_price string商品原价总和,数值保留到小数点后两位,以店铺币种金额展示。
- total_outstanding string未付款金额总额,数值保留到小数点后两位,以店铺币种金额展示。
- total_tax string税费总额,数值保留到小数点后两位,以店铺币种金额展示。
- total_tip_received string小费,数值保留到小数点后两位,以店铺币种金额展示。
- total_weight double商品总重量,单位:g。
- user_id string买家 ID。
状态码
收到 SHOPLINE 发送的 Webhook 通知后,你需要按照如下 SHOPLINE 要求的格式进行响应。
HTTP/1.1 200 OK关于如何订阅 Webhooks 及更多 Webhook 响应规则说明,请参考 Webhook 概述。
这篇文章对你有帮助吗?