订单删除
| 事件分组 | 事件标识 |
|---|---|
| orders | orders/delete |
订单删除
请求头
- 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 string调整金额,在pos场景下因金额四舍五入带来的平衡金额例子:
8.00 adjust_price_setobject
按照店铺币种和交易币种计价的调整金额presentment_moneyobject
买家侧的金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
卖家侧的金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDbilling_addressobject
账 单地址address1 string详细地址1例子:地址1address2 string详细地址2,备选例子:地址2city string城市例子:纽约company string公司名称例子:新公司名country string国家/地区例子:美国country_code string国家/地区编码例子:USfirst_name string名例子:Tomlast_name string姓例子:Washingtonname string姓名例子:Tom Washingtonphone string电话例子:18723465843province string省/二级地址例子:加利福尼亚州province_code string省/二级地址编码例子:4200006zip string邮编例子:54213- browser_ip string浏览器ip例子:
157.119.232.35 - buyer_note string买家备注例子:
备注 - cancel_reason string取消订单原因例子:
"不想买了" - cancelled_at string取消时间例子:
2012-05-01T14:22:25-04:00 - cart_token string购物车token例子:
c2c4a58186b9d96395d7e6b5c2969577 - checkout_id string当前订单关联的弃单id例子:
2404785166526352972864 - checkout_token string结算页token例子:
c2c4a58186b9d96395d7e6b5c2969577 client_detailsobject
客户端信息browser_ip string浏览器IP例子:157.119.232.35session_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 stringuuid例子:432354345companyobject
公司信息id string公司id例子:1026538935748524location_id string地点id例子:326538935748524tax_registration_id string税号信息例子:503002- created_at string创建订单时间例子:
2021-08-16T08:27:57+00:00 - currency string结算币种例子:
USD - current_subtotal_price string当前商品总和,商品总价*数量例子:
8.00 current_subtotal_price_setobject
当前商品总和多币种信息, 买卖家币种和金额一致presentment_moneyobject
买家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USD- current_total_discounts string折扣总和,精度2,营销优惠+人工折扣例子:
8.00 current_total_discounts_setobject
折扣总和多币种信息,没有多币种,所以买卖家币种和金额一致presentment_moneyobject
买家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDcurrent_total_duties_setobject
当前商品总关税presentment_moneyobject
买家侧金额信息amount string金额例子:8.88currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额例子:8.88currency_code string币种例子:USD- current_total_price string当前订单总额,取值逻辑:商品总额 - 优惠总额 + 运费 + 税费例子:
8.00 current_total_price_setobject
当前订单总额多币种信息,买卖家币种和金额一致presentment_moneyobject
买家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USD- current_total_tax string税费总和,商品税 + 运费税例子:
8.00 current_total_tax_setobject
税费总和多币种信息, 买卖家币种和金额一致presentment_moneyobject
买家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDcustomerobject
买家信息addressesobject
地址address1 string详细地址1例子:地址1address2 string详细地址2,备选例子:地址2city string城市例子:纽约country string国家/地区例子:美国country_code string国家/地区编码例子:USfirst_name string名例子:Tomlast_name string姓例子:Washingtonname string全名例子:Tom Washingtonphone string电话例子:13100000000province string省例子:加利福尼亚州province_code string省编码例子:4200006zip string邮编例子:98734area_code string手机区号例子:+86created_at string买家创建时间例子:2022-11-04T10:18:46+00:00currency string币种例子:USDemail string用户邮箱例子:test1001@Gmail.comfirst_name string名例子:Tomid string用户id例子:4201057495last_name string姓例子:Washingtonphone string用户手机号例子:13100000000- customer_locale string买家国家 语种编码+国家名称缩写例子:
enCN - deduct_member_point_amount string当前订单会员积分抵扣金额例子:
8.00 deduct_member_point_amount_setobject
当前订单会员积分抵扣金额,多币种信息presentment_moneyobject
买家侧金额信息amount string金额例子:8.88currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额例子:8.88currency_code string币种例子:USDdiscount_applicationsobject[]
该订单应用的所有折扣信息allocation_method string活动的折扣应用范围 1)across(该值分布在所有授权行中) 2)each(该值应用于每个授权行)例子:acrosscode string折扣码例子:1Q3UMQM8RBP5description string活动的具体描述例子:活动的具体描述target_selection string活动的折扣应用具体对象 1)explicit(折扣分配到明确选择的商品行或运费行) 2)all(折扣分配到所有商品行或运费行) 3)ENTITLED(折扣仅分配到其有权使用的商品行或运费行)例子:alltarget_type string活动的折扣应用对象 1)line_item 2)shipping_line例子:line_itemtitle string自动折扣的标题例子:活动的具体描述type string活动折扣类型 1)manual(自定义类型) 2)automatic(自动折扣类型) 3)discount_code(折扣码类型)例子:manualvalue string活动的折扣值例子:20value_type string活动的折扣值类型,包含百分比和固定金额两类例子:fixed_amountdiscount_codesobject[]
优惠码信息amount string优惠金额,精度2例子:8.00amount_setobject
amount,多币种信息presentment_moneyobject
买家侧金额信息amount string金额例子:8.00currency_code string币种例子:currency_codeshop_moneyobject
卖家侧金额信息amount string金额例子:8.00currency_code string币种例子:USDcode string优惠码例子:KIN4GNAB2FRHtype string优惠类型, 1-减金额;2-打折;3-免运费;8-固定售价;9-最低价商品免费;10-打包价;11-第N件打折;例子:减金额- email string买家邮箱例子:
test001@Gmail.com - financial_status string支付状态: unpaid - 未支付; authorized - 已授权;pending-支付中; partially_paid-部分支付; paid-已支付; partially_refunded-部分退款; refunded-已退款;例子:
unpaid - fulfillment_status string发货状态, fulfilled-已发货; partial-部分发货; null-未发货; 注:返回的枚举值与入参的查询枚举值不一样例子:
fulfilled fulfillmentsobject[]
包裹信息created_at string创建时间(格式见IOS8601)例子:2022-11-04T10:18:46+00:00id string包裹编号例子:22046737798141702810214336line_itemsobject[]
商品列表attribute string商品属性:名称 - 属性值 多个以逗号", "分割 如:颜色 - 红色, 尺寸 - X例子:大fulfillable_quantity integer可发货数量例子:1fulfillment_quantity integer发货数量例子:1fulfillment_service string物流商名称,如果一种商品有多个不同的发货服务商,则以逗号分隔例子:顺丰国际fulfillment_status string商品的发货状态, 发货状态, fulfilled-已发货; partial-部分发货; null-未发货;例子:fulfilledgrams double重量(克)例子:100id string商品快照表的id, 系统生成,与订单号唯一确认一个商品例子:412image_url string商品图片例子:https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969location_id string地点ID例子:5445886274929439997name stringsku标题例子:test-002price string商品售价,精度2例子:8.00price_setobject
商品售价,多币种信息presentment_moneyobject
买家侧金额信息amount string金额例子:8.00currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额例子:8.00currency_code string币种例子:USDproduct_id stringspu序列号例子:16056761559984840457934011quantity integer订单中的商品数量例子:3requires_shipping boolean是否需要发货例子:truesku string商品码例子:18056761559987524812644011tax_linesobject[]
税费信息price string价格例子:8.00price_setobject
税费多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDrate double税率例子:1title string税费名称例子:税费taxable boolean是否收税例子:truetitle string商品标题例子:漂亮的裙子variant_id string商品sku序列号例子:18056761559987524812644011variant_title string商品属性值, 多个以" / "分割, 如: “155 / 红色 / 大"例子:大vendor string供应商例子:供应商name string发货单短号例子:1032-F2order_id string订单号例子:21056577640603870897253153shipment_status string包裹状态例子:fulfilledstatus string物流配送状态, success-已发货; cancelled-已取消;例子:successtracking_company string物流公司名称例子:顺丰国际tracking_number string第三方物流单号例子:yun0001tracking_url string物流公司url例子:https://www.sf-international.com/updated_at string更新时间(格式见IOS8601)例子:2022-11-04T10:18:46+00:00- hidden_order boolean是否是归档订单, true=已归档订单, false=未归档订单例子:
true - id string系统订单号例子:
21056577640603870897253153 line_itemsobject[]
订单商品快照信息attribute string商品属性:名称 - 属性值 多个以逗号", "分割 如:颜色 - 红色, 尺寸 - X例子:红色discount_allocationsobject[]
折扣明细金额多币种amount string折扣明细金额例子:8.00amount_setobject
折扣明细金额多币种presentment_moneyobject
支付币种amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
店铺币种amount string金额,精度2例子:8.00currency_code string币种例子:USDdiscount_application_index integer标明在折扣明细中的位置例子:1dutiesobject[]
关税信息country_code_of_origin string原产地/发货地的国家代码harmonized_system_code string海关编码id string关税编号priceobject
关税多币种信息presentment_moneyobject
买家侧金额信息amount string金额例子:8.88currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额例子:8.88currency_code string币种例子:USDtax_linesobject[]
税费明细列表price_setobject
税费多币种信息presentment_moneyobject
买家侧金额信息amount string金额例子:8.88currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额例子:8.88currency_code string币种例子:USDrate string税率rate_percentage string税率(百份比的值,即rate * 100)title string税费标题fulfillable_quantity integer可发货数量例子:1fulfillment_service string物流商名称,如果一种商品有多个不同的发货服务商,则以逗号分隔例子:顺丰国际fulfillment_status string商品的发货状态, 发货状态, fulfilled-已发货; partial-部分发货; null-未发货;例子:yun0001gift_card boolean是否为礼品卡商品grams double重量(克)例子:100id string商品快照表的id, 系统生成,与订单号唯一确认一个商品例子:413image_url string商品图片例子:https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969location_id string地点ID例子:5327026538935748524name stringsku标题例子:商品标题price string商品售价,精度2例子:8.00price_setobject
商品售价,多币种金额信息presentment_moneyobject
支付币种amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
店铺币种amount string金额,精度2例子:8.00currency_code string币种例子:USDproduct_id stringspu序列号例子:16056761559984840457934011propertiesobject[]
商品定制信息additional string定制商品附加字段例子:附加name string自定义属性名称例子:自定义属性type string属性类型, text-字符,展示格式为 name: value; picture-图片,展示类型为 name: 通过urls获取渲染出缩略图;link-超链,展示类型为 name: value,支持点击链接跳转 到urls第一个例子:texturls arrayurl资源列表例子:["https://www.url.com"]value string自定义属性值例子:自定义属性值quantity integer订单中的商品数量例子:1requires_shipping boolean是否需要发货例子:truesku string商品码例子:18056761559987524812644011tags string商品标签(多个逗号隔开)例子:手表tax_linesobject[]
税费信息price string价格例子:8.00price_setobject
税费多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDrate double税率例子:1title string税费名称例子:税费type string税费用类型,用于区分是商品税还是运费税,枚举值如下 product_tax:商品税 shipping_tax:运费税例子:shipping_taxtaxable boolean是否收税例子:truetitle string商品标题例子:好看的裙子variant_id string商品sku序列号例子:18056761559987524812644011variant_title string商品属性值, 多个以" / "分割, 如: “155 / 红色 / 大"例子:大vendor string供应商例子:供应商locationsobject[]
地点信息location_id string地点ID例子:5327026538935748524name string地点名称例子:us.streettype string1.posLocation: POS渠道创建该订单的门店地点(建议使用posLocationId,后续将废弃) 2.pickupLocation: 当订单的配送方式为自提时,自提的门店地点 3.productLocation: 订单中商品的库存地点(建议使用商品行中的location信息,后续将废弃)例子:posLocation- name string自定义单号(会变化)例子:
test001 - note string商家备注内容, 多个以逗号分隔例子:
备注 note_attributesobject[]
商家备注日志,日期内容create_time string备注创建时间(格式见IOS8601)例子:2022-11-04T10:18:46+00:00name string备注来源(卖家标识)例子:备注来源value string备注内容例子:内容- order_at string成单时间例子:
2021-08-16T08:27:57+00:00 - order_source string订单来源渠道,目前只有pos渠道该字段才有值,其他渠道该值为空例子:
pos - order_status_url string订单状态页url例子:
https://shoptest.myshopline.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509 payment_detailsobject[]
支付单信息create_time string支付单创建时间例子:2021-08-16T08:27:57+00:00pay_amount double支付金额例子:8pay_channel_deal_id string支付流水号:支付渠道生成的支付号例子:pi_3MI897Hezv8FxjBO1uGxMPhXpay_seq string支付网支付单号, SL内部定义的支付单的唯一编号请求号例子:23057287797738260472676128pay_status string支付状态例子:unpaidprocessed_at string支付创建时间,格式:2023-04-12T22:59:52+08:00例子:2023-04-12T22:59:52+08:00status_code string支付状态码例子:RISK_PENDINGstatus_msg string支付单状态码描述例子:PENDING_REVIEW- payment_gateway_names array付款方式列表,该订单所用到的付款方式列表例子:
["Paypal"] - phone string买家联系方式例子:
13100000000 - pos_location_id stringpos交易地点例子:
5227248679317408779 - presentment_currency string买家侧币种例子:
USD - processed_at string成单时间,格式:2023-04-12T22:59:52+08:00 2023-04-12T22:59:52+08:00例子:
2023-04-12T22:59:52+08:00 - processed_user_id string订单创建者例子:
4201057495 refundsobject[]
退款列表created_at string退款单创建时间 (格式见IOS8601)例子:2021-08-16T08:27:57+00:00id string退款id例子:2605659027312156877634note string退款备注例子:备注order_id string订单号例子:21056577640603870897253153processed_at string更新时间例子:2021-08-16T08:27:57+00:00refund_line_itemsobject[]
退款商品id string退款单号例子:2605659027312156877634line_item_id string商品快照表的id, 系统生成,与订单号唯一确认一个商品例子:101quantity string数量,商品数量例子:1restock_type string库存返还类型,no_restock-未返还,cancel-取消, return-返还例子:no_restocksubtotal string退款金额合计,精度2例子:1.00subtotal_setobject
退款金额合计,多币种信息,卖家和买家侧相同presentment_moneyobject
买家侧币种amount string金额,精度2例子:1.00currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额,精度2例子:1.00currency_code string币种例子:USDtotal_tax_setobject
总税额,多币种信息presentment_moneyobject
买家侧币种amount string金额,精度2例子:1.00currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额,精度2例子:1.00currency_code string币种例子:USDuser_id string用户id例子:4201057495shipping_addressobject
收货地址address1 string详细地址1例子:地址1address2 string详细地址2,备选例子:地址2city string城市例子:纽约company string公司名称例子:新公司country string国家例子:美国country_code string国家码例子:USdelivery_store_code string门店编码例子:1001delivery_store_name string门店名称例子:店铺district string区例子:番禺区district_code string区编码例子:5213300first_name string名例子:Tomlast_name string姓例子:Washingtonlatitude string地址纬度例子:23.35773longitude string地址经度例子:116.4151name string全名例子:Tom Washingtonphone string电话例子:13100000000province string省份例子:加利福尼亚州province_code string省份码例子:4200006zip string邮编例子:521000shipping_linesobject[]
物流信息code string物流编号例子:SF1232344456776discount_allocationsobject[]
折扣明细金额多币种展示amount string折扣金额,精度2例子:8.00amount_setobject
折扣多币种金额presentment_moneyobject
买家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
店铺侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDdiscount_application_index integer在折扣明细中的位置例子:1discounted_price string折扣金额,精度2例子:8.00discounted_price_setobject
折扣多币种金额presentment_moneyobject
买家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
店铺侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDphone string电话例子:13100000000price string物流运费, double类型的字符串例子:8.00price_setobject
物流运费多资源信息presentment_moneyobject
买家侧币种金额amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
卖家侧币种金额amount string金额,精度2例子:8.00currency_code string币种例子:USDshipping_price string原运费金额值(非折扣后金额)例子:8.00source string物流类型例子:SHOPLINEtax_linesobject[]
物流税费信息price string价格例子:8.00price_setobject
税费多币种信息presentment_moneyobject
买家侧币种金额amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
卖家侧币种金额amount string金额,精度2例子:8.00currency_code string币种例子:USDrate double税率例子:1title string税费名称例子:税费title string物流名称例子:顺丰国际- status string订单状态,open-处理中,cancelled-已取消例子:
open - store_id string店铺ID例子:
1644828244663 - subtotal_price string商品折后价总和, 商品总价 - 营销优惠 - 人工折扣例子:
8.00 subtotal_price_setobject
商品折后价总和多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USD- tags string订单标签例子:
手表 tax_linesobject[]
税费信息price string价格例子:8.00price_setobject
多币种金额信息presentment_moneyobject
买家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDrate double税率例子:1title string税费名称例子:税费- tax_number string税号例子:
11111 - tax_type string税号类型例子:
类型 - taxes_included boolean总计额是否包含税额例子:
true - total_discounts string折扣总额,营销优惠+人工折扣例子:
8.00 total_discounts_setobject
折扣总额多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USD- total_line_items_price string商品原价总和,精度2例子:
8.00 total_line_items_price_setobject
商品原价总和,多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USD- total_outstanding string未付款金额总和,精度2例子:
8.00 total_outstanding_setobject
未付款金额总和,多币种信息presentment_moneyobject
买家侧金额信息amount string金额例子:8.88currency_code string币种例子:USDshop_moneyobject
卖家侧金额信 息amount string金额例子:8.88currency_code string币种例子:USDtotal_shipping_price_setobject
订单运费总和,多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USD- total_tax string税费总和,精度2, 商品税 + 运费税例子:
8.00 total_tax_setobject
税费总和,多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
卖家侧的金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USD- total_tip_received string小费,精度2例子:
8.00 total_tip_received_setobject
小费,多币种信息presentment_moneyobject
买家侧金额信息amount string金额例子:8.88currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额例子:8.88currency_code string币种例子:USD- total_weight double商品总重量(g)
- updated_at string订单更新时间,(格式见IOS8601)例子:
2021-08-16T08:27:57+00:00 - user_id string买家id例子:
4201057495
状态码
收到 SHOPLINE 发送的 Webhook 通知后,你需要按照如下 SHOPLINE 要求的格式进行响应。
HTTP/1.1 200 OK关于如何订阅 Webhooks 及更多 Webhook 响应规则说明,请参考 Webhook 概述。
这篇文章对你有帮助吗?