取消订单归档

需要 write_orders 权限点。

更多权限点使用信息，请参考：

[]

访问权限。

PUT https://{handle}.myshopline.com/admin/openapi/v20260301/orders/:id/cancel_hide_mark.json

[]

handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。

[]

取消归档订单v1

路径参数

id string required
[]
订单号
[]
Example: 21050342939778451436179579

请求头

Content-Type string required
[]
字段值固定为 application/json; charset=utf-8。
Authorization string required
[]
资源的访问令牌。参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

状态码

[]

更多状态码信息，参考 HTTP 状态码。

响应头

traceId
[]
请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。

响应体

orderobject
[]
订单信息,字段描述、示例请参考订单列表响应结果
updated_at string
[]
订单更新时间，（格式见IOS8601）
Example: 2012-05-01T14:22:25-04:00
deduct_member_point_amount string
[]
当前订单会员积分抵扣金额
Example: 3.25
subtotal_price string
[]
商品折后价总和, 商品总价 - 营销优惠 - 人工折扣
Example: 3.25
tags string
[]
订单标签
Example: 标签
tax_type string
[]
税号类型
Example: 类型
total_tax_setobject
[]
税费总和，多币种信息
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额，精度2
Example: 8.00
currency_code string
[]
币种
Example: USD
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额，精度2
Example: 8.00
currency_code string
[]
币种
Example: USD
fulfillment_status string
[]
发货状态， fulfilled-已发货; partial-部分发货； null-未发货; 注：返回的枚举值与入参的查询枚举值不一样
Example: fulfilled
line_itemsobject[]
[]
订单商品快照信息
sku string
[]
商品码，barCode
Example: 18056761559987524812644011
title string
[]
商品标题
Example: 好看的裙子
location_id string
[]
pos场景下店铺对应的地点
Example: 5327026538935748524
taxable boolean
[]
是否收税
Example: true
variant_title string
[]
商品属性值, 多个以" / "分割, 如： “155 / 红色 / 大"
Example: 大
id string
[]
商品快照表的id, 系统生成，与订单号唯一确认一个商品
Example: 417
quantity integer
[]
订单中的商品数量
Example: 2
grams double
[]
重量（克）
Example: 100
price string
[]
商品售价，精度2
Example: 3.25
fulfillable_quantity integer
[]
可发货数量
Example: 1
fulfillment_status string
[]
商品的发货状态，发货状态， fulfilled-已发货; partial-部分发货； null-未发货;
Example: fulfilled
propertiesobject[]
[]
商品定制信息
urls array
[]
url资源列表
Example: ["https://www.url.com"]
value string
[]
自定义属性值
Example: 属性值
additional string
[]
定制商品附加字段
Example: 附加字段
name string
[]
自定义属性名称
Example: 属性名称
type string
[]
属性类型, text-字符，展示格式为 name: value; picture-图片，展示类型为 name: 通过urls获取渲染出缩略图；link-超链，展示类型为 name: value，支持点击链接跳转到urls第一个
Example: text
product_id string
[]
spu序列号
Example: 16056761559984840457934011
fulfillment_service string
[]
物流商名称
Example: 顺丰
requires_shipping boolean
[]
是否需要发货
Example: true
tax_linesobject[]
[]
税费信息
type string
[]
税费用类型，用于区分是商品税还是运费税，枚举值如下 product_tax：商品税 shipping_tax：运费税
Example: shipping_tax
price string
[]
税费，精度2
Example: 3.25
price_setobject
[]
税费多币种信息
presentment_moneyobject
[]
买家侧币种
amount string
[]
金额
Example: 3.25
currency_code string
[]
币种
Example: USD
shop_moneyobject
[]
卖家侧币种
amount string
[]
金额
Example: 3.25
currency_code string
[]
币种
Example: USD
rate double
[]
税率
Example: 1
title string
[]
税费名称
Example: 税费
variant_id string
[]
商品sku序列号
Example: 18056761559987524812644011
attribute string
[]
商品属性：名称 - 属性值多个以逗号", "分割如：颜色 - 红色, 尺寸 - X
Example: 红色
tags string
[]
商品标签（多个逗号隔开）
Example: 标签1,可爱的
vendor string
[]
供应商
Example: 供应商
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
name string
[]
sku标题,同title
Example: 商品标题
customer_locale string
[]
买家国家，语种编码+国家名称缩写
Example: enCN
id string
[]
订单号，系统自定义编号
Example: 21050224312121887324667162
discount_codesobject[]
[]
优惠码信息
type string
[]
优惠类型，减金额；打折；免运费；固定售价；最低价商品免费；打包价；第N件打折；
Example: 减金额
amount string
[]
优惠金额,精度2
Example: 3.25
code string
[]
优惠码
Example: KIN4GNAB2FRH
current_total_discounts string
[]
折扣总和，精度2，营销优惠+人工折扣
Example: 3.25
total_tip_received string
[]
小费，精度2
Example: 8.00
current_total_price string
[]
税费总和，商品税 + 运费税
Example: 8.00
total_discounts_setobject
[]
折扣总额多币种信息
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额，精度2
Example: 3.25
currency_code string
[]
币种
Example: USD
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额，精度2
Example: 3.25
currency_code string
[]
币种
Example: USD
taxes_included boolean
[]
总计额是否包含税额
phone string
[]
买家联系方式，二者必有其一
Example: 12903001000
billing_addressobject
[]
账单地址
name string
[]
账单收件姓名
Example: Tom Washington
city string
[]
账单收件人城市（最大64个字符）
Example: 纽约
country_code string
[]
账单收件人国家编码
Example: US
phone string
[]
账单收件人名手机号
Example: 13890312312
zip string
[]
账单收件人名邮编
Example: 521000
country string
[]
账单收件人国家（最大64个字符）
Example: 美国
first_name string
[]
账单收件人名
Example: Tom
province_code string
[]
账单收件人名省份编码
Example: 4300006
company string
[]
公司名称
Example: 新公司
last_name string
[]
账单收件人姓
Example: Washington
province string
[]
账单收件人名省份
Example: 加利福尼亚州
address1 string
[]
账单收件人详细地址（最大255个字符）
Example: 地址1
address2 string
[]
账单收件人详细地址附加（最大255个字符）
Example: 地址2
order_status_url string
[]
订单状态页url
Example: https://shoptest.myshoplinestg.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509
current_total_price_setobject
[]
税费总和多币种信息，买卖家币种和金额一致
presentment_moneyobject
[]
买家侧币种
amount string
[]
金额
Example: 8.00
currency_code string
[]
币种
Example: USD
shop_moneyobject
[]
卖家侧币种
amount string
[]
金额
Example: 8.00
currency_code string
[]
币种
Example: USD
shipping_addressobject
[]
收货地址
country string
[]
国家
Example: 美国
last_name string
[]
名
Example: Washington
longitude string
[]
经度
Example: 41
name string
[]
全名
Example: Tom Washington
company string
[]
公司名称
Example: 新公司名
province_code string
[]
省份码
Example: 4200006
country_code string
[]
国家码
Example: US
zip string
[]
邮编
Example: 92503
address2 string
[]
详细地址2，备选
Example: 地址2
first_name string
[]
姓
Example: Tom
phone string
[]
电话
Example: 1320987655
address1 string
[]
地址1
Example: 地址1
city string
[]
城市
Example: 纽约
latitude string
[]
纬度
Example: 15
province string
[]
省份
Example: 加利福尼亚州
total_line_items_price string
[]
商品原价总和，精度2
Example: 8.00
total_shipping_price_setobject
[]
订单运费总和，多币种信息
presentment_moneyobject
[]
买家侧金额信息
currency_code string
[]
币种
Example: USD
amount string
[]
金额，精度2
Example: 8.00
shop_moneyobject
[]
卖家侧金额信息
currency_code string
[]
币种
Example: USD
amount string
[]
金额，精度2
Example: 8.00
total_tax string
[]
税费总和，精度2, 商品税 + 运费税
Example: 8.00
store_id string
[]
店铺id
Example: 1644828244663
current_total_tax string
[]
税费总和，商品税 + 运费税
Example: 8.00
note_attributesobject[]
[]
商家备注日志，日期内容
create_time string
[]
备注创建时间（格式见IOS8601）
Example: 2012-05-01T14:22:25-04:00
name string
[]
备注来源（卖家标识）
Example: 备注来源
value string
[]
备注内容
Example: 备注内容
created_at string
[]
订单创建时间（格式见IOS8601）
Example: 2012-05-01T14:22:25-04:00
tax_linesobject[]
[]
税费信息
rate double
[]
税率
Example: 1
title string
[]
税费名称
Example: 税费
price string
[]
税费金额
Example: 3.25
price_setobject
[]
税费多币种信息
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额，精度2
Example: 3.25
currency_code string
[]
币种
Example: USD
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额，精度2
Example: USD
currency_code string
[]
币种
total_weight double
[]
商品总重量（g）
Example: 100
checkout_id string
[]
弃单id
Example: 2404785166526352972864
subtotal_price_setobject
[]
商品折后价总和多币种信息
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额，精度2
Example: 3.25
currency_code string
[]
币种
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额，精度2
Example: 3.25
currency_code string
[]
币种
Example: USD
customerobject
[]
买家信息
currency string
[]
币种
Example: USD
first_name string
[]
名
Example: Tom
id string
[]
用户id
Example: 4201057495
updated_at string
[]
买家更新时间
Example: 2012-05-01T14:22:25-04:00
addressesobject
[]
买家地址信息
country_code string
[]
国家码
Example: US
last_name string
[]
名
Example: Washington
name string
[]
全名
Example: Tom Washington
zip string
[]
邮编
Example: 52134
first_name string
[]
姓
Example: Tom
phone string
[]
电话
Example: 13652133421
province string
[]
省份
Example: 加利福尼亚州
province_code string
[]
省份码
Example: 4300006
address1 string
[]
详细地址1
Example: 地址1
address2 string
[]
详细地址2，备选
Example: 地址2
city string
[]
城市
Example: 纽约
country string
[]
国家
Example: 美国
area_code string
[]
手机区号
Example: +86
created_at string
[]
买家创建时间（格式见IOS8601）
Example: 2012-05-01T14:22:25-04:00
last_name string
[]
姓
Example: Washington
phone string
[]
用户手机号
Example: 19872121232
email string
[]
用户邮箱
Example: test001@Gmail.com
processed_at string
[]
processed_at 成单时间,格式：2023-04-12T22:59:52+08:00
Example: 2023-04-12T22:59:52+08:00
checkout_token string
[]
结算页token
Example: c2c4a58186b9d96395d7e6b5c2969577
shipping_linesobject[]
[]
物流信息
discounted_price string
[]
折扣金额，精度2
Example: 8.00
phone string
[]
电话
Example: 13243214565
price_setobject
[]
物流运费多资源信息
presentment_moneyobject
[]
买家侧金额信息
currency_code string
[]
币种
Example: USD
amount string
[]
金额，精度2
Example: 8.00
shop_moneyobject
[]
店铺侧金额信息
amount string
[]
金额，精度2
Example: 8.00
currency_code string
[]
币种
Example: USD
requested_fulfillment_service_id string
[]
运输服务代号
Example: LX88888
price string
[]
物流运费,精度2
Example: 8.00
shipping_price string
[]
原运费金额值（非折扣后金额）
Example: 8.00
source string
[]
运费来源
Example: 来源
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
title string
[]
物流名称
Example: 顺丰国际
code string
[]
物流编号
Example: SF
tax_linesobject[]
[]
物流征税列表
price string
[]
税费
Example: 8.00
price_setobject
[]
税费多币种信息
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额
Example: 8.00
currency_code string
[]
币种
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额，精度2
Example: 8.00
currency_code string
[]
币种
Example: USD
rate double
[]
税率
Example: 1
title string
[]
税费名称
Example: 税费
discount_allocationsobject[]
[]
折扣明细
amount string
[]
折扣金额，精度2
Example: 8.00
amount_setobject
[]
折扣多币种金额
presentment_moneyobject
[]
买家侧金额信息
currency_code string
[]
币种
Example: USD
amount string
[]
金额，精度2
Example: 8.00
shop_moneyobject
[]
店铺侧金额信息
currency_code string
[]
币种
Example: USD
amount string
[]
金额，精度2
Example: 8.00
discount_application_index integer
[]
折扣索引信息：标明在折扣明细中的位置
Example: 1
cancel_reason string
[]
卖家取消原因
Example: “不想买了”
browser_ip string
[]
客户端ip
Example: 157.119.232.35
processed_user_id string
[]
订单创建者
Example: 4201057495
total_line_items_price_setobject
[]
商品原价总和，多币种信息
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额，精度2
Example: 8.00
currency_code string
[]
币种
Example: USD
presentment_moneyobject
[]
买家侧金额信息
currency_code string
[]
币种
Example: USD
amount string
[]
金额，精度2
Example: 8.00
current_total_tax_setobject
[]
税费总和多币种信息，买卖家币种和金额一致
presentment_moneyobject
[]
买家侧币种
amount string
[]
金额
Example: 8.00
currency_code string
[]
币种
Example: USD
shop_moneyobject
[]
卖家侧币种
amount string
[]
金额
Example: 8.00
currency_code string
[]
币种
Example: USD
currency string
[]
交易币种
Example: USD
user_id string
[]
买家id
Example: 4201057495
app_id string
[]
应用方id
Example: 222222
cart_token string
[]
购物车token
Example: c2c4a58186b9d96395d7e6b5c2969577
email string
[]
买家邮箱,二者必有其一
Example: test1002@Gmail.com
current_subtotal_price string
[]
当前商品总和，商品总价*数量
Example: 78.08
current_total_discounts_setobject
presentment_moneyobject
[]
买家侧金额
amount string
[]
金额
Example: 3.25
currency_code string
[]
币种信息
Example: USD
shop_moneyobject
[]
卖家侧金额
amount string
[]
金额
Example: 3.25
currency_code string
[]
币种
Example: USD
total_outstanding string
[]
未付款金额总和，精度2
Example: 8.00
total_discounts string
[]
折扣总额，营销优惠+人工折扣
Example: 3.25
tax_number string
[]
税号
Example: 111111
name string
[]
自定义订单号
Example: test1001
current_subtotal_price_setobject
[]
当前商品总和多币种信息，买卖家币种和金额一致
shop_moneyobject
[]
卖家侧金额
currency_code string
[]
币种code
Example: USD
amount string
[]
金额，精度2
Example: 78.08
presentment_moneyobject
[]
买家侧币种
amount string
[]
金额
Example: 78.08
currency_code string
[]
币种
Example: USD
fulfillmentsobject[]
[]
包裹信息
id string
[]
包裹编号
Example: 22046737798141702810214336
tracking_number string
[]
第三方物流单号
Example: yun0001
name string
[]
发货单短号
Example: 1032-F2
order_id string
[]
订单号
Example: 21056577640603870897253153
shipment_status string
[]
包裹状态
Example: fulfilled
tracking_company string
[]
物流公司名称
Example: 顺丰国际
updated_at string
[]
更新时间（格式见IOS8601）
Example: 2012-05-01T14:22:25-04:00
line_itemsobject[]
[]
商品列表
name string
[]
sku标题,同title
Example: 商品名称
requires_shipping boolean
[]
是否需要发货
variant_title string
[]
商品属性值, 多个以" / "分割, 如： “155 / 红色 / 大"
Example: 大
attribute string
[]
商品属性：名称 - 属性值多个以逗号", "分割如：颜色 - 红色, 尺寸 - X
Example: 红色
fulfillment_service string
[]
物流商名称
Example: 顺丰
fulfillment_status string
[]
商品的发货状态，发货状态， fulfilled-已发货; partial-部分发货； null-未发货;
Example: fulfilled
taxable boolean
[]
是否收税
Example: true
sku string
[]
商品码，barCode
Example: 18056761559987524812644011
fulfillable_quantity integer
[]
可发货数量
Example: 1
variant_id string
[]
商品sku序列号
Example: 18056761559987524812644011
grams double
[]
重量（克）
Example: 100
product_id string
[]
spu序列号
Example: 16056761559984840457934011
tax_linesobject[]
[]
税费信息
price_setobject
[]
税费多币种信息
presentment_moneyobject
[]
买家侧金额
amount string
[]
金额
Example: 3.25
currency_code string
[]
币种
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额
Example: 3.25
currency_code string
[]
币种
Example: USD
rate double
[]
税率
Example: 1
title string
[]
税费名称
Example: 税费
price string
[]
税费，精度2
Example: 3.25
quantity integer
[]
订单中的商品数量
Example: 1
price string
[]
商品售价，精度2
Example: 23.09
title string
[]
商品标题
Example: 漂亮的裙子
vendor string
[]
供应商
Example: 供应商
id string
[]
商品快照表的id, 系统生成，与订单号唯一确认一个商品
Example: 312
status string
[]
物流配送状态， success-已发货； cancelled-已取消；
Example: cancelled
tracking_url string
[]
物流公司url
Example: https://www.sf-international.com/
created_at string
[]
创建时间（格式见IOS8601）
Example: 2012-05-01T14:22:25-04:00
presentment_currency string
[]
买家侧币种,同卖家侧币种
Example: USD
financial_status string
[]
支付状态，unpaid，authorized, pending，partially_paid，paid，partially_refunded，refunded
Example: unpaid
payment_detailsobject[]
[]
支付单信息
status_code string
[]
支付状态码
Example: RISK_PENDING
pay_amount double
[]
支付金额
Example: 3.25
pay_status string
[]
支付单状态, unpaid-未支付；pending-支付中；risking-风控中；paid-已支付；paid_overtime-支付失败；paid_failed-支付失败；
Example: unpaid
processed_at string
[]
支付创建时间,格式：2023-04-12T22:59:52+08:00
Example: 2023-04-12T22:59:52+08:00
create_time string
[]
支付单创建时间
Example: 2012-05-01T14:22:25-04:00
order_seq string
[]
订单号
Example: 23057287797738260472676128
pay_seq string
[]
支付单号
Example: 23057287797738260472676128
status_msg string
[]
支付单状态码描述
Example: PENDING_REVIEW
pay_channel_deal_id string
[]
外部渠道支付流水号
Example: pi_3MI897Hezv8FxjBO1uGxMPhX
cancelled_at string
[]
订单取消时间（结束）（格式见IOS8601）,2012-05-01T14:22:25-04:00
Example: 2012-05-01T14:22:25-04:00
discount_applicationsobject[]
[]
折扣信息
target_selection string
[]
1）explicit（折扣分配到明确选择的行） 2）all（折扣分配到所有行） 3）ENTITLED（折扣仅分配到其有权使用的行）
Example: explicit
value_type string
[]
百分比折扣、金额折扣
Example: fixed_amount
description string
[]
自定义折扣的描述
Example: 折扣描述
title string
[]
自动折扣的标题
Example: 折扣标题
type string
[]
折扣类型
Example: manual
value string
[]
折扣的具体值（可以是 N折，也可以是具体的金额值）
Example: 20
allocation_method string
[]
1）across（该值分布在所有授权行中） 2）each（该值应用于每个授权行）
Example: across
target_type string
[]
1）line_item、shipping_line
Example: line_item
code string
[]
折扣码
Example: 1Q3UMQM8RBP5
client_detailsobject
[]
客户端详细信息
browser_ip string
[]
客户端IP地址
Example: 157.119.232.35
session_hash string
[]
会员会话加密信息
Example: c2c4a58186b9d96395d7e6b5c2969577
user_agent string
[]
客户端代理
Example: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Sa
note string
[]
商家备注内容
Example: 备注内容
refundsobject[]
[]
退款列表
created_at string
[]
退款单创建时间（格式见IOS8601）
Example: 2012-05-01T14:22:25-04:00
id string
[]
退款id
Example: 2605659027312156877634
note string
[]
退款备注
Example: 退款备注
order_id string
[]
订单号
Example: 21056577640603870897253153
processed_at string
[]
更新时间（格式见IOS8601）
Example: 2012-05-02T14:22:25-04:00
refund_line_itemsobject[]
[]
退款详细信息
total_tax_setobject
[]
总税额，多币种信息
presentment_moneyobject
[]
买家侧币种
amount string
[]
金额
Example: 3.25
currency_code string
[]
币种
Example: USD
shop_moneyobject
[]
卖家侧币种
amount string
[]
金额
Example: 3.25
currency_code string
[]
币种
Example: USD
line_itemobject
[]
退款商品行
attribute string
[]
商品属性：名称 - 属性值多个以逗号", "分割如：颜色 - 红色, 尺寸 - X
Example: 红色
quantity integer
[]
订单中的商品数量
Example: 2
fulfillable_quantity integer
[]
可发货数量
Example: 2
taxable boolean
[]
是否收税
Example: true
requires_shipping boolean
[]
是否需要发货
Example: true
product_id string
[]
spu序列号
Example: 16056761559984840457934011
price string
[]
商品售价，精度2
Example: 3.25
tax_linesobject[]
[]
税费信息
title string
[]
税费标题
Example: 税费
price string
[]
税费，精度2
Example: 3.25
price_setobject
[]
税费多币种信息
presentment_moneyobject
[]
买家侧币种
amount string
[]
金额，精度2
Example: 3.25
currency_code string
[]
币种
Example: USD
shop_moneyobject
[]
卖家侧金额信息
currency_code string
[]
币种
Example: USD
amount string
[]
金额
Example: 3.25
rate double
[]
税率
Example: 1
fulfillment_status string
[]
商品的发货状态，发货状态， fulfilled-已发货; partial-部分发货； null-未发货;
Example: fulfilled
grams double
[]
重量（克）
Example: 100
name string
[]
sku标题,同title
Example: test-002
variant_id string
[]
商品sku序列号
Example: 18056761559987524812644011
id string
[]
商品快照表的id, 系统生成，与订单号唯一确认一个商品
Example: 312
sku string
[]
商品码，barCode
Example: 18056761559987524812644011
title string
[]
商品标题
Example: 漂亮的裙子
variant_title string
[]
商品属性值, 多个以" / "分割, 如： “155 / 红色 / 大"
Example: 大
fulfillment_service string
[]
物流商名称
Example: 顺丰
vendor string
[]
供应商
Example: 供应商
subtotal_setobject
[]
退款金额合计，多币种信息，卖家和买家侧相同
presentment_moneyobject
[]
买家侧币种
amount string
[]
金额
Example: 3.25
currency_code string
[]
币种
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额，精度2
Example: 3.25
currency_code string
[]
币种
Example: USD
id string
[]
该调整单关联的订单号
Example: 2605659027312156877634
line_item_id string
[]
商品快照表的id, 系统生成，与订单号唯一确认一个商品
Example: 302
restock_type string
[]
库存返还类型,no_restock-未返还，cancel-取消， return-返还只有未返还
Example: no_restock
total_tax double
[]
退款商品的税额，精度2
quantity integer
[]
数量,商品数量
Example: 2
subtotal double
[]
退款金额合计，精度2
Example: 3.25
transactionsobject[]
[]
退款交易信息
order_id string
[]
订单号
Example: 21056577640603870897253153
processed_at string
[]
退款单更新时间（格式见IOS8601）
Example: 2012-05-01T14:22:25-04:00
user_id string
[]
买家id
Example: 4201057495
kind string
[]
交易类型（authorization， capture， sale， void， refund）
Example: authorization
status string
[]
处理状态, pending, failure, success, and error
Example: pending
amount string
[]
退款金额，精度2
Example: 3.25
currency string
[]
币种
Example: USD
created_at string
[]
创建时间
Example: 2012-05-01T14:22:25-04:00
id string
[]
退款id
Example: 2605659027312156877634
user_id string
[]
用户id
Example: 4201057495
payment_gateway_names array
[]
付款方式列表,该订单所用到的付款方式列表, SLpayments ,Paypal(PayPal支付), Oceanpay(钱海支付), TwoCheckout,AsiaBill, Stripe,Pacypay, WorldPay, COD（货到付款), CUSTOM(自定义), adjustPay（资金调整）, Xendit(xendit信用卡), XenditOther
Example: ["PayPal"]
user_errorsobject[]
[]
本次执行的错误提示信息，如果执行结果有错误，会通过此字段返回错误信息
code string
[]
错误码
Example: illegal param
field array
[]
导致错误的输入字段的路径
Example: [""]
message string
[]
错误信息

API Explorer

调试台

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

id — path required

Authorization — header required

Language

curl --request PUT \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/orders/id/cancel_hide_mark.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

这篇文章对你有帮助吗？

SHOPLINE

条款协议