取消订单归档
PUT https://{handle}.myshopline.com/admin/openapi/v20270301/orders/:id/cancel_hide_mark.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handle 是 open001 。取消归档订单v1
路径参数
- id string required订单号例子:
21050342939778451436179579
请求头
- Content-Type string required字段值固定为
application/json; charset=utf-8。 - Authorization string required资源的访问令牌。参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。例子:
Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA
状态码
- 200
- 401
- 429
更多状态码信息,参考 HTTP 状态码。
响应头
traceId
请求的全局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。
响应体
orderobject
订单信息,字段描述、示例请参考订单列表响应结果total_tax_setobject
税费总和,多币种信息shop_moneyobject
卖家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDpresentment_moneyobject
买家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDcustomer_locale string买家国家,语种编 码+国家名称缩写例子:enCNtotal_tip_received string小费,精度2例子:8.00shipping_addressobject
收货地址first_name string姓例子:Tomlast_name string名例子:Washingtonlongitude string经度例子:41country_code string国家码例子:USaddress2 string详细地址2,备选例子:地址2zip string邮编例子:92503latitude string纬度例子:15province string省份例子:加利福尼亚州address1 string地址1例子:地址1city string城市例子:纽约country string国家例子:美国name string全名例子:Tom Washingtoncompany string公司名称例子:新公司名province_code string省份码例子:4200006phone string电话例子:1320987655presentment_currency string买家侧币种,同卖家侧币种例子:USDcurrent_total_discounts string折扣总和,精度2,营销优惠+人工折扣例子:3.25total_line_items_price string商品原价总和,精度2例子:8.00store_id string店铺id例子:1644828244663subtotal_price string商品折后价总和, 商品总价 - 营销优惠 - 人工折扣例子:3.25line_itemsobject[]
订单商品快照信息fulfillment_status string商品的发货状态, 发货状态, fulfilled-已发货; partial-部分发货; null-未发货;例子:fulfilledpropertiesobject[]
商品定制信息type string属性类型, text-字符,展示格式为 name: value; picture-图片,展示类型为 name: 通过urls获取渲染出缩略图;link-超链,展示类型为 name: value,支持点击链接跳转 到urls第一个例子:texturls arrayurl资源列表例子:["https://www.url.com"]value string自定义属性值例子:属性值additional string定制商品附加字段例子:附加字段name string自定义属性名称例子:属性名称product_id stringspu序列号例子:16056761559984840457934011tax_linesobject[]
税费信息type string税费用类型,用于区分是商品税还是运费税,枚举值如下 product_tax:商品税 shipping_tax:运费税例子:shipping_taxprice string税费,精度2例子:3.25price_setobject
税费多币种信息presentment_moneyobject
买家侧币种amount string金额例子:3.25currency_code string币种例子:USDshop_moneyobject
卖家侧币种amount string金额例子:3.25currency_code string币种例子:USDrate double税率例子:1title string税费名称例子:税费vendor string供应商例子:供应商title string商品标题例子:好看的裙子location_id stringpos场景下店铺对应的地点例子:5327026538935748524quantity integer订单中的商品数量例子:2requires_shipping boolean是否需要发货例子:truevariant_id string商品sku序列号例子:18056761559987524812644011name stringsku标题,同title例子:商品标题sku string商品码,barCode例子:18056761559987524812644011variant_title string商品属性值, 多个以" / "分割, 如: “155 / 红色 / 大"例子:大grams double重量(克)例子:100attribute 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标明在折扣明细中的位置例子:1fulfillable_quantity integer可发货数量例子:1fulfillment_service string物流商名称例子:顺丰tags string商品标签(多个逗号隔开)例子:标签1,可爱的taxable boolean是否收税例子:trueid string商品快照表的id, 系统生成,与订单号唯一确认一个商品例子:417price string商品售价,精度2例子:3.25processed_at stringprocessed_at 成单时间,格式:2023-04-12T22:59:52+08:00例子:2023-04-12T22:59:52+08:00id string订单号,系统自定义编号例子:21050224312121887324667162current_total_price string税费总和,商品税 + 运费税例子:8.00note_attributesobject[]
商家备注日志,日期内容create_time string备注创建时间(格式见IOS8601)例子:2012-05-01T14:22:25-04:00name string备注来源(卖家标识)例子:备注来源value string备注内容例子:备注内容email string买家邮箱,二者必有其一例子:test1002@Gmail.comcurrent_total_discounts_setobject
shop_moneyobject
卖家侧金额amount string金额例子:3.25currency_code string币种例子:USDpresentment_moneyobject
买家侧金额amount string金额例子:3.25currency_code string币种信息例子:USDtaxes_included boolean总计额是否包含税额total_tax string税费总和,精度2, 商品税 + 运费税例子:8.00currency string交易币种例子:USDapp_id string应用方id例子:222222cart_token string购物车token例子:c2c4a58186b9d96395d7e6b5c2969577current_subtotal_price string当前商品总和,商品总价*数量例子:78.08fulfillmentsobject[]
包裹信息name string发货单短号例子:1032-F2order_id string订单号例子:21056577640603870897253153shipment_status string包裹状态例子:fulfilledtracking_company string物流公司名称例子:顺丰国际updated_at string更新时间(格式见IOS8601)例子:2012-05-01T14:22:25-04:00line_itemsobject[]
商品列表name stringsku标题,同title例子:商品名称attribute string商品属性:名称 - 属性值 多个以逗号", "分割 如:颜色 - 红色, 尺寸 - X例子:红色variant_id string商品sku序列号例子:18056761559987524812644011grams double重量(克)例子:100price string商品售价,精度2例子:23.09sku string商品码,barCode例子:18056761559987524812644011fulfillable_quantity integer可发货数量例子:1quantity integer订单中的商品数量例子:1vendor string供应商例子:供应商requires_shipping boolean是否需要发货fulfillment_service string物流商名称例子:顺丰id string商品快照表的id, 系统生成,与订单号唯一确认一个商品例子:312variant_title string商品属性值, 多个以" / "分割, 如: “155 / 红色 / 大"例子:大fulfillment_status string商品的发货状态, 发货状态, fulfilled-已发货; partial-部分发货; null-未发货;例子:fulfilledtaxable boolean是否收税例子:trueproduct_id stringspu序列号例子:16056761559984840457934011tax_linesobject[]
税费信息price_setobject
税费多币种信息shop_moneyobject
卖家侧金额信息amount string金额例子:3.25currency_code string币种例子:USDpresentment_moneyobject
买家侧金额amount string金额例子:3.25currency_code string币种例子:USDrate double税率例子:1title string税费名称例子:税费price string税费,精度2例子:3.25title string商品标题例子:漂亮的裙子status string物流配送状态, success-已发货; cancelled-已取消;例子:cancelledid string包裹编号例子:22046737798141702810214336tracking_url string物流公司url例子:https://www.sf-international.com/created_at string创建时间(格式见IOS8601)例子:2012-05-01T14:22:25-04:00tracking_number string第三方物流单号例子:yun0001client_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 Safulfillment_status string发货状态, fulfilled-已发货; partial-部分发货; null-未发货; 注:返回的枚举值与入参的查询枚举值不一样例子:fulfilledtotal_shipping_price_setobject
订单运费总和,多币种信息presentment_moneyobject
买家侧金额信息currency_code string币种例子:USDamount string金额,精度2例子:8.00shop_moneyobject
卖家侧金额信息currency_code string币种例子:USDamount string金额,精度2例子:8.00checkout_id string弃单id例子:2404785166526352972864total_line_items_price_setobject
商品原价总和,多币种信息presentment_moneyobject
买家侧金额信息currency_code string币种例子:USDamount string金额,精度2例子:8.00shop_moneyobject
卖家侧金额信息currency_code string币种例子:USDamount string金额,精度2例子:8.00total_discounts string折扣总额,营销优惠+人工折扣例子:3.25payment_detailsobject[]
支付单信息status_code string支付状态码例子:RISK_PENDINGpay_amount double支付金额例子:3.25pay_status string支付单状态, unpaid-未支付;pending-支付中;risking-风控中;paid-已支付;paid_overtime-支付失败;paid_failed-支付失败;例子:unpaidcreate_time string支付单创建时间例子:2012-05-01T14:22:25-04:00order_seq string订单号例子:23057287797738260472676128pay_seq string支付单号例子:23057287797738260472676128processed_at string支付创建时间,格式:2023-04-12T22:59:52+08:00例子:2023-04-12T22:59:52+08:00status_msg string支付单状态码描述例子:PENDING_REVIEWpay_channel_deal_id string外部渠道支付流水号例子:pi_3MI897Hezv8FxjBO1uGxMPhXdiscount_applicationsobject[]
折扣信息title string自动折扣的标题例子:折扣标题value string折扣的具体值(可以是 N折,也可以是具体的 金额值)例子:20allocation_method string1)across(该值分布在所有授权行中) 2)each(该值应用于每个授权行)例子:acrosstarget_type string1)line_item、shipping_line例子:line_itemcode string折扣码例子:1Q3UMQM8RBP5value_type string百分比折扣、金额折扣例子:fixed_amounttype string折扣类型例子:manualtarget_selection string1)explicit(折扣分配到明确选择的行) 2)all(折扣分配到所有行) 3)ENTITLED(折扣仅分配到其有权使用的行)例子:explicitdescription string自定义折扣的描述例子:折扣描述checkout_token string结算页token例子:c2c4a58186b9d96395d7e6b5c2969577name string自定义订单号例子:test1001current_subtotal_price_setobject
当前商品总和多币种信息, 买卖家币种和金额一致shop_moneyobject
卖家侧金额currency_code string币种code例子:USDamount string金额,精度2例子:78.08presentment_moneyobject
买家 侧币种currency_code string币种例子:USDamount string金额例子:78.08phone string买家联系方式,二者必有其一例子:12903001000browser_ip string客户端ip例子:157.119.232.35tags string订单标签例子:标签tax_type string税号类型例子:类型billing_addressobject
账单地址city string账单收件人城市(最大64个字符)例子:纽约country_code string账单收件人国家编码例子:USphone string账单收件人名手机号例子:13890312312province_code string账单收件人名省份编码例子:4300006province string账单收件人名省份例子:加利福尼亚州address2 string账单收件人详细地址附加(最大255个字符)例子:地址2name string账单收件姓名例子:Tom Washingtonzip string账单收件人名邮编例子:521000country string账单收件人国家(最大64个字符)例子:美国first_name string账单收件人名例子:Tomcompany string公司名称例子:新公司last_name string账单收件人姓例子:Washingtonaddress1 string账单收件人详细地址(最大255个字符)例子:地址1shipping_linesobject[]
物流信息title string物流名称例子:顺丰国际tax_linesobject[]
物流征税列表price string税费例子:8.00price_setobject
税费多币种信息presentment_moneyobject
买家侧金额信息amount string金额例子:8.00currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDrate double税率例子:1title string税费名称例子:税费discount_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.00requested_fulfillment_service_id string运输服务代号例子:LX88888price string物流运费,精度2例子:8.00source string运费来源例子:来源discounted_price_setobject
折扣多币种金额presentment_moneyobject
买家侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDshop_moneyobject
店铺侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDcode string物流编号例子:SFphone string电话例子:13243214565price_setobject
物流运费多资源信息presentment_moneyobject
买家侧金额信息currency_code string币种例子:USDamount string金额,精度2例子:8.00shop_moneyobject
店铺侧金额信息amount string金额,精度2例子:8.00currency_code string币种例子:USDshipping_price string原运费金额值(非折扣后金额)例子:8.00financial_status string支付状态,unpaid,authorized, pending,partially_paid,paid,partially_refunded,refunded例子:unpaidtotal_outstanding string未付款金额总和,精度2例子:8.00total_discounts_setobject
折扣总额多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2例子:3.25currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息currency_code string币种例子:USDamount string金额,精度2例子:3.25tax_linesobject[]
税费信息rate double税率例子:1title string税费名称例子:税费price string税费金额例子:3.25price_setobject
税费多币种信息shop_moneyobject
卖家侧金额信息amount string金额,精度2例子:3.25currency_code string币种例子:USDpresentment_moneyobject
买家侧金额信息amount string金额,精度2例子:USDcurrency_code string币种processed_user_id string订单创建者例子:4201057495payment_gateway_names array付款方式列表,该订单所用到的付款方式列表, SLpayments ,Paypal(PayPal支付), Oceanpay(钱海支付), TwoCheckout,AsiaBill, Stripe,Pacypay, WorldPay, COD(货到付款), CUSTOM(自定义), adjustPay(资金调整), Xendit(xendit信用卡), XenditOther例子:["PayPal"]current_total_tax string税费总和,商品税 + 运费税例子:8.00subtotal_price_setobject
商品折后价总和多币种 信息presentment_moneyobject
买家侧金额信息amount string金额,精度2例子:3.25currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额,精度2例子:3.25currency_code string币种例子:USDupdated_at string订单更新时间,(格式见IOS8601)例子:2012-05-01T14:22:25-04:00deduct_member_point_amount string当前订单会员积分抵扣金额例子:3.25total_weight double商品总重量(g)例子:100customerobject
买家信息first_name string名例子:Tomid string用户id例子:4201057495updated_at string买家更新时间例子:2012-05-01T14:22:25-04:00addressesobject
买家地址信息address1 string详细地址1例子:地址1country_code string国家码例子:USlast_name string名例子:Washingtonname string全名例子:Tom Washingtonprovince_code string省份码例子:4300006address2 string详细地址2,备选例子:地址2city string城市例子:纽约country string国家例子:美国zip string邮编例子:52134first_name string姓例子:Tomphone string电话例子:13652133421province string省份例子:加利福尼亚州last_name string姓例子:Washingtonphone string用户手机号例子:19872121232email string用户邮箱例子:test001@Gmail.comcurrency string币种例子:USDarea_code string手机区号例子:+86created_at string买家创建时间(格式见IOS8601)例子:2012-05-01T14:22:25-04:00cancelled_at string订单取消时间(结束)(格式见IOS8601),2012-05-01T14:22:25-04:00例子:2012-05-01T14:22:25-04:00note string商家备注内容例子:备注内容tax_number string税号例子:111111discount_codesobject[]
优惠码信息type string优惠类型,减金额;打折;免运费;固定售价;最低价商品免费;打包价;第N件打折;例子:减金额amount string优惠金额,精度2例子:3.25code string优惠码例子:KIN4GNAB2FRHorder_status_url string订单状态页url例子:https://shoptest.myshoplinestg.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509created_at string订单创建时间(格式见IOS8601)例子:2012-05-01T14:22:25-04:00cancel_reason string卖家取消原因例子:“不想买了”current_total_tax_setobject
税费总和多币种信息, 买卖家币种和金额一致shop_moneyobject
卖家侧币种amount string金额例子:8.00currency_code string币种例子:USDpresentment_moneyobject
买家侧币种amount string金额例子:8.00currency_code string币种例子:USDrefundsobject[]
退款列表id string退款id例子:2605659027312156877634note string退款备注例子:退款备注order_id string订单号例子:21056577640603870897253153processed_at string更新时间 (格式见IOS8601)例子:2012-05-02T14:22:25-04:00refund_line_itemsobject[]
退款详细信息total_tax_setobject
总税额,多币种信息presentment_moneyobject
买家侧币种amount string金额例子:3.25currency_code string币种例子:USDshop_moneyobject
卖家侧币种amount string金额例子:3.25currency_code string币种例子:USDsubtotal_setobject
退款金额合计,多币种信息,卖家和买家侧相同presentment_moneyobject
买家侧币种amount string金额例子:3.25currency_code string币种例子:USDshop_moneyobject
卖家侧金额信息amount string金额,精度2例子:3.25currency_code string币种例子:USDrestock_type string库存返还类型,no_restock-未返还,cancel-取消, return-返还 只有未返还例子:no_restocksubtotal double退款金额合计,精度2例子:3.25line_itemobject
退款商品行requires_shipping boolean是否需要发货例子:trueprice string商品售价,精度2例子:3.25tax_linesobject[]
税费信息title string税费标题例子:税费price string税费,精度2例子:3.25price_setobject
税费多币种信息presentment_moneyobject
买家侧币种currency_code string币种例子:USDamount string金额,精度2例子:3.25shop_moneyobject
卖家侧金额信息amount string金额例子:3.25currency_code string币种例子:USDrate double税率例子:1id string商品快照表的id, 系统生成,与订单号唯一确认一个商品例子:312variant_title string商品属性值, 多个以" / "分割, 如: “155 / 红色 / 大"例子:大attribute string商品属性:名称 - 属性值 多个以逗号", "分割 如:颜色 - 红色, 尺寸 - X例子:红色quantity integer订单中的商品数量例子:2fulfillment_status string商品的发货状态, 发货状态, fulfilled-已发货; partial-部分发货; null-未发货;例子:fulfilledvendor string供应商例子:供应商fulfillable_quantity integer可发货数量例子:2taxable boolean是否收税例子:trueproduct_id stringspu序列号例子:16056761559984840457934011grams double重量(克)例子:100name stringsku标题,同title例子:test-002variant_id string商品sku序列号例子:18056761559987524812644011title string商品标题例子:漂亮的裙子fulfillment_service string物流商名称例子:顺丰sku string商品码,barCode例子:18056761559987524812644011id string该调整单关联的订单号例子:2605659027312156877634line_item_id string商品快照表的id, 系统生成,与订单号唯一确认一个商品例子:302total_tax double退款商品的税额,精度2quantity integer数量,商品数量例子:2transactionsobject[]
退款交易信息order_id string订单号例子:21056577640603870897253153processed_at string退款单更新时间(格式见IOS8601)例子:2012-05-01T14:22:25-04:00user_id string买家id例子:4201057495status string处理状态, pending, failure, success, and error例子:pendingcurrency string币种例子:USDcreated_at string创建时间例子:2012-05-01T14:22:25-04:00id string退款id例子:2605659027312156877634kind string交易类型(authorization, capture, sale, void, refund)例子:authorizationamount string退款金额,精度2例子:3.25user_id string用户id例子:4201057495created_at string退款单创建时间 (格式见IOS8601)例子:2012-05-01T14:22:25-04:00current_total_price_setobject
税费总和多币种信息, 买卖家币种和金额一致presentment_moneyobject
买家侧币种amount string金额例子:8.00currency_code string币种例子:USDshop_moneyobject
卖家侧币种amount string金额例子:8.00currency_code string币种例子:USDuser_id string买家id例子:4201057495user_errorsobject[]
本次执行的错误提示信息,如果执行结果有错误,会通过此字段返回错误信息message string错误信息code string错误码例子:illegal paramfield array导致错误的输入字段的路径例子:[""]
API Explorer
调试台
这篇文章对你有帮助吗?