事件分组事件标识
fulfillmentsfulfillments/update
当发货单更新时触发。
请求头
  • 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
请求体
  • created_at string
    发货单创建时间。格式:ISO 8601
    例子: 2024-08-31T02:20:26+08:00
  • id string
    发货单 ID。
  • line_itemsobject[]
    发货单的商品列表。
  • fulfillable_quantity integer
    商品行维度剩余可履约的商品数量。
  • fulfillment_service string
    物流商名称。
  • fulfillment_status string
    发货状态。有效枚举值包含:
    • unshipped:未发货
    • partial:部分发货
    • shipped:已发货
  • gift_card boolean
    是否为礼品卡商品。
    • true:是礼品卡商品
    • false:不是礼品卡商品
  • grams double
    商品总重量,单位:g。
  • id string
    商品快照表的唯一标识 ID,系统生成,与订单号唯一确认一个商品。
  • name string
    商品标题,该字段值和 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。
  • quantity integer
    商品款式的数量。
  • requires_shipping boolean
    该商品是否需要运输。
    • true:需要运输
    • false:不需要运输
  • sku 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
    税率,该信息只做展示作用。
  • 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
    发货单物流追踪状态。有效枚举值包含:
    • label_purchased:物流标签已购买
    • label_printed:物流标签已打印
    • ready_for_pickup:等待物流公司取件
    • picked_up:物流公司已取件
    • confirmed:包裹已确认
    • in_transit:运输中
    • attempted_delivery:尝试派送,表示快递员尝试派送包裹但未成功
    • out_for_delivery:正在配送
    • delivered:已送达
    • failure:配送失败
  • 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
状态码
收到 SHOPLINE 发送的 Webhook 通知后,你需要按照如下 SHOPLINE 要求的格式进行响应。
HTTP/1.1 200 OK
关于如何订阅 Webhooks 及更多 Webhook 响应规则说明,请参考 Webhook 概述
这篇文章对你有帮助吗?