事件分组事件标识
ordersorders/updated
订单更新
请求头
  • X-Shopline-Topic string required
    事件操作标识
    Example: orders/edited
  • X-Shopline-Hmac-Sha256 string required
    签名
    Example: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
  • X-Shopline-Shop-Domain string required
    店铺域名
    Example: shophub.myshopline.com
  • X-Shopline-Shop-Id string required
    店铺id
    Example: 1610418123456
  • X-Shopline-Merchant-Id string required
    商户ID
    Example: 2000001234
  • X-Shopline-API-Version string required
    版本号
    Example: v20210901
  • X-Shopline-Webhook-Id string required
    消息ID
    Example: b54557e48a5fbf7d70bcd043
请求体
  • adjust_price string
    调整金额
  • adjust_price_setobject
    调整金额
  • presentment_moneyobject
    买家侧的金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • shop_moneyobject
    卖家侧的金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • billing_addressobject
    账单地址
  • address1 string
    详细地址1
  • address2 string
    详细地址2
  • city string
    城市
  • company string
    公司名称
  • country string
    国家/地区
  • country_code string
    国家/地区编码
  • first_name string
  • last_name string
  • name string
    姓名
  • phone string
    电话
  • province string
    省/二级地址
  • province_code string
    省/二级地址编码
  • zip string
    邮编
  • browser_ip string
    浏览器ip
  • buyer_note string
    买家备注
  • cancel_reason string
    取消订单原因
  • cancelled_at string
    取消时间
  • cart_token string
    购物车token
  • checkout_id string
    当前订单关联的弃单id
  • checkout_token string
    结算页token
  • client_detailsobject
    客户端信息
  • browser_ip string
    浏览器IP
  • session_hash string
    sessionId
  • user_agent string
    客户端代理
  • uuid string
    uuid
  • created_at string
    创建订单时间
  • currency string
    结算币种
  • current_subtotal_price string
    当前商品总和,商品总价*数量
  • current_subtotal_price_setobject
    当前商品总和多币种信息, 买卖家币种和金额一致
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • current_total_discounts string
    折扣总和,精度2,营销优惠+人工折扣
  • current_total_discounts_setobject
    折扣总和多币种信息,没有多币种,所以买卖家币种和金额一致
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • current_total_price string
    当前订单总额,取值逻辑:商品总额 - 优惠总额 + 运费 + 税费
  • current_total_price_setobject
    当前订单总额多币种信息,买卖家币种和金额一致
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • current_total_tax string
    税费总和,商品税 + 运费税
  • current_total_tax_setobject
    税费总和多币种信息, 买卖家币种和金额一致
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • customerobject
    买家信息
  • addressesobject
    地址
  • address1 string
    详细地址1
  • address2 string
    详细地址2,备选
  • city string
    城市
  • country string
    国家/地区
  • country_code string
    国家/地区编码
  • first_name string
  • last_name string
  • name string
    全名
  • phone string
    电话
  • province string
  • province_code string
    省编码
  • zip string
    邮编
  • area_code string
    手机区号
  • created_at string
    买家创建时间
  • currency string
    币种
  • email string
    用户邮箱
  • first_name string
  • id string
    用户id
  • last_name string
  • phone string
    用户手机号
  • customer_locale string
    买家国家 语种编码+国家名称缩写
  • deduct_member_point_amount string
    当前订单会员积分抵扣金额
  • discount_applicationsobject[]
    该订单应用的所有折扣信息
  • allocation_method string
    活动的折扣应用范围 1)across(该值分布在所有授权行中) 2)each(该值应用于每个授权行)
    Example: across
  • code string
    活动的具体描述
    Example: 1Q3UMQM8RBP5
  • description string
    活动的具体描述
    Example: 活动的具体描述
  • target_selection string
    活动的折扣应用具体对象 1)explicit(折扣分配到明确选择的商品行或运费行) 2)all(折扣分配到所有商品行或运费行) 3)ENTITLED(折扣仅分配到其有权使用的商品行或运费行)
    Example: all
  • target_type string
    活动的折扣应用对象 1)line_item 2)shipping_line
    Example: line_item
  • title string
    活动的具体描述
    Example: 活动的具体描述
  • type string
    活动折扣类型 1)manual(自定义类型) 2)automatic(自动折扣类型) 3)discount_code(折扣码类型)
    Example: manual
  • value string
    活动的折扣值
    Example: 20
  • value_type string
    活动的折扣值类型,包含百分比和固定金额两类
    Example: fixed_amount
  • discount_codesobject[]
    优惠码信息
  • amount string
    优惠金额,精度2
  • code string
    优惠码
  • type string
    优惠类型, 1-减金额;2-打折;3-免运费;8-固定售价;9-最低价商品免费;10-打包价;11-第N件打折;
  • email string
    买家邮箱
  • financial_status string
    支付状态: unpaid - 未支付; authorized - 已授权;pending-支付中; partially_paid-部分支付; paid-已支付; partially_refunded-部分退款; refunded-已退款;
  • fulfillment_status string
    发货状态, fulfilled-已发货; partial-部分发货; null-未发货; 注:返回的枚举值与入参的查询枚举值不一样
  • fulfillmentsobject[]
    包裹信息
  • created_at string
    创建时间(格式见IOS8601)
  • id string
    包裹编号
  • line_itemsobject[]
    商品列表
  • attribute string
    商品属性:名称 - 属性值 多个以逗号", "分割 如:颜色 - 红色, 尺寸 - X
  • fulfillable_quantity integer
    可发货数量
  • fulfillment_service string
    物流商名称,如果一种商品有多个不同的发货服务商,则以逗号分隔
  • fulfillment_status string
    商品的发货状态, 发货状态, fulfilled-已发货; partial-部分发货; null-未发货;
  • grams double
    重量(克)
  • id string
    商品快照表的id, 系统生成,与订单号唯一确认一个商品
  • image_url string
    商品图片
  • location_id string
    地点ID
  • name string
    sku标题
  • price string
    商品售价,精度2
  • product_id string
    spu序列号
  • quantity integer
    订单中的商品数量
  • requires_shipping boolean
    是否需要发货
  • sku string
    商品码
  • tax_linesobject[]
    税费信息
  • price string
    价格
  • price_setobject
    税费多币种信息
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • rate double
    税率
  • title string
    税费名称
  • taxable boolean
    是否收税
  • title string
    商品标题
  • variant_id string
    商品sku序列号
  • variant_title string
    商品属性值, 多个以" / "分割, 如: “155 / 红色 / 大"
  • vendor string
    供应商
  • name string
    发货单短号
    Example: 1032-F2
  • order_id string
    订单号
  • shipment_status string
    包裹状态
  • status string
    物流配送状态, success-已发货; cancelled-已取消;
  • tracking_company string
    物流公司名称
  • tracking_number string
    第三方物流单号
  • tracking_url string
    物流公司url
  • updated_at string
    更新时间(格式见IOS8601)
  • hidden_order boolean
    是否是归档订单, true=已归档订单, false=未归档订单
  • id string
    系统订单号
  • line_itemsobject[]
    订单商品快照信息
  • attribute string
    商品属性:名称 - 属性值 多个以逗号", "分割 如:颜色 - 红色, 尺寸 - X
  • discount_allocationsobject[]
    折扣明细金额多币种
  • amount string
    折扣明细金额
    Example: 8.00
  • amount_setobject
    折扣明细金额多币种
  • presentment_moneyobject
    支付币种
  • amount string
    金额,精度2
    Example: 8.00
  • currency_code string
    币种
    Example: USD
  • shop_moneyobject
    店铺币种
  • amount string
    金额,精度2
    Example: 8.00
  • currency_code string
    币种
    Example: USD
  • discount_application_index integer
    标明在折扣明细中的位置
    Example: 1
  • fulfillable_quantity integer
    可发货数量
  • fulfillment_service string
    物流商名称,如果一种商品有多个不同的发货服务商,则以逗号分隔
  • fulfillment_status string
    商品的发货状态, 发货状态, fulfilled-已发货; partial-部分发货; null-未发货;
  • gift_card boolean
    是否为礼品卡商品
  • grams double
    重量(克)
  • id string
    商品快照表的id, 系统生成,与订单号唯一确认一个商品
  • image_url string
    商品图片
  • location_id string
    地点ID
  • name string
    sku标题
  • price string
    商品售价,精度2
  • price_setobject
    商品售价,多币种金额信息
  • presentment_moneyobject
    支付币种
  • amount string
    金额,精度2
    Example: 8.00
  • currency_code string
    币种
    Example: USD
  • shop_moneyobject
    店铺币种
  • amount string
    金额,精度2
    Example: 8.00
  • currency_code string
    币种
    Example: USD
  • product_id string
    spu序列号
  • propertiesobject[]
    商品定制信息
  • additional string
    定制商品附加字段
  • name string
    自定义属性名称
  • type string
    属性类型, text-字符,展示格式为 name: value; picture-图片,展示类型为 name: 通过urls获取渲染出缩略图;link-超链,展示类型为 name: value,支持点击链接跳转 到urls第一个
  • urls array
    url资源列表
    Example: ``
  • value string
    自定义属性值
  • quantity integer
    订单中的商品数量
  • requires_shipping boolean
    是否需要发货
  • sku string
    商品码
  • tags string
    商品标签(多个逗号隔开)
  • tax_linesobject[]
    税费信息
  • price string
    价格
  • price_setobject
    税费多币种信息
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • rate double
    税率
  • title string
    税费名称
  • type string
    税费用类型,用于区分是商品税还是运费税,枚举值如下 product_tax:商品税 shipping_tax:运费税
    Example: shipping_tax
  • taxable boolean
    是否收税
  • title string
    商品标题
  • variant_id string
    商品sku序列号
  • variant_title string
    商品属性值, 多个以" / "分割, 如: “155 / 红色 / 大"
  • vendor string
    供应商
  • name string
    自定义单号(会变化)
  • note string
    商家备注内容, 多个以逗号分隔
  • note_attributesobject[]
    商家备注日志,日期内容
  • create_time string
    备注创建时间(格式见IOS8601)
  • name string
    备注来源(卖家标识)
  • value string
    备注内容
  • order_at string
    成单时间
  • order_status_url string
    订单状态页url
  • payment_detailsobject[]
    支付单信息
  • create_time string
    支付单创建时间
  • pay_amount double
    支付金额
  • pay_channel_deal_id string
    支付流水号:支付渠道生成的支付号
  • pay_seq string
    支付网支付单号, SL内部定义的支付单的唯一编号请求号
  • pay_status string
    支付状态
  • payment_gateway_names array
    付款方式列表,该订单所用到的付款方式列表
    Example: ``
  • phone string
    买家联系方式
  • presentment_currency string
    买家侧币种
  • processed_user_id string
    订单创建者
    Example: 4201057495
  • refundsobject[]
    退款列表
  • created_at string
    退款单创建时间 (格式见IOS8601)
  • id string
    退款id
  • note string
    退款备注
  • order_id string
    订单号
  • processed_at string
    更新时间
  • user_id string
    用户id
  • shipping_addressobject
    收货地址
  • address1 string
    详细地址1
  • address2 string
    详细地址2,备选
  • city string
    城市
  • company string
    公司名称
  • country string
    国家
  • country_code string
    国家码
  • delivery_store_code string
    门店编码
  • delivery_store_name string
    门店名称
  • district string
  • district_code string
    区编码
  • first_name string
  • last_name string
  • latitude string
    地址纬度
    Example: 23.35773
  • longitude string
    地址经度
    Example: 116.4151
  • name string
    全名
  • phone string
    电话
  • province string
    省份
  • province_code string
    省份码
  • zip string
    邮编
  • shipping_linesobject[]
    shippingLines
  • code string
    物流编号
  • discount_allocationsobject[]
    折扣明细金额多币种展示
  • amount string
    折扣金额,精度2
    Example: 8.00
  • amount_setobject
    折扣多币种金额
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额,精度2
    Example: 8.00
  • currency_code string
    币种
    Example: USD
  • shop_moneyobject
    店铺侧金额信息
  • amount string
    金额,精度2
    Example: 8.00
  • currency_code string
    币种
    Example: USD
  • discount_application_index integer
    在折扣明细中的位置
    Example: 1
  • discounted_price string
    折扣金额,精度2
  • discounted_price_setobject
    折扣多币种金额
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额,精度2
    Example: 8.00
  • currency_code string
    币种
    Example: USD
  • shop_moneyobject
    店铺侧金额信息
  • amount string
    金额,精度2
    Example: 8.00
  • currency_code string
    币种
    Example: USD
  • phone string
    电话
  • price string
    物流运费, double类型的字符串
  • price_setobject
    物流运费多资源信息
  • presentment_moneyobject
    买家侧币种金额
  • amount string
    金额,精度2
  • currency_code string
    币种
  • shop_moneyobject
    卖家侧币种金额
  • amount string
    金额,精度2
  • currency_code string
    币种
  • shipping_price string
    原运费金额值(非折扣后金额)
    Example: 8.00
  • source string
    物流类型
  • tax_linesobject[]
    物流名称
  • price string
    价格
  • price_setobject
    税费多币种信息
  • presentment_moneyobject
    卖家侧币种金额
  • amount string
    金额,精度2
  • currency_code string
    币种
  • shop_moneyobject
    买家侧币种金额
  • amount string
    金额,精度2
  • currency_code string
    币种
  • rate double
    税率
  • title string
    税费名称
  • title string
    物流名称
  • status string
    订单状态,open-处理中,cancelled-已取消
  • store_id string
    店铺ID
  • subtotal_price string
    商品折后价总和, 商品总价 - 营销优惠 - 人工折扣
  • subtotal_price_setobject
    商品折后价总和多币种信息
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • tags string
    订单标签
  • tax_linesobject[]
    税费
  • price string
    价格
  • price_setobject
    多币种金额信息
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • rate double
    税率
  • title string
    税费名称
  • tax_number string
    税号
  • tax_type string
    税号类型
  • taxes_included boolean
    总计额是否包含税额
  • total_discounts string
    折扣总额,营销优惠+人工折扣
  • total_discounts_setobject
    折扣总额多币种信息
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • total_line_items_price string
    商品原价总和,精度2
  • total_line_items_price_setobject
    商品原价总和,多币种信息
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • total_outstanding string
    未付款金额总和,精度2
  • total_shipping_price_setobject
    订单运费总和,多币种信息
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • total_tax string
    税费总和,精度2, 商品税 + 运费税
  • total_tax_setobject
    税费总和,多币种信息
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • shop_moneyobject
    卖家侧的金额信息
  • amount string
    金额,精度2
  • currency_code string
    币种
  • total_tip_received string
    小费,精度2
  • total_weight double
    商品总重量(g)
  • updated_at string
    订单更新时间,(格式见IOS8601)
  • user_id string
    买家id
响应
收到 SHOPLINE 发送的 Webhook 通知后,你需要按照如下 SHOPLINE 要求的格式进行响应。
HTTP/1.1 200 OK
关于如何订阅 Webhooks 及更多 Webhook 响应规则说明,请参考 Webhook 概述
这篇文章对你有帮助吗?

Error loading component.

Error loading component.