取消订单

需要 write_orders 权限点。

更多权限点使用信息,请参考:

[]

访问权限

POST https://{handle}.myshopline.com/admin/openapi/v20250601/orders/:id/cancel.json

[]

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

[]

取消订单

路径参数

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

请求头

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

请求体

amount double
[]
amount
[]
Example: 100
cancel_reason string
[]
cancelReason
[]
Example: "不想买了"
currency string
[]
currency
[]
Example: "CNY"
email boolean
[]
是否发送邮件
[]
Example: true
processed_at string
[]
取消订单实际发生时间
[]
Example: 2023-04-12T22:59:52+08:00
restock boolean
[]
库存是否回退 ture:库存回退 false和空字段为不回退库存
[]
Example: true

响应

[]

更多状态码信息请参考 HTTP 状态码

响应头

traceId
[]
traceId

响应体

orderobject
[]
订单信息,字段描述、示例请参考订单列表响应结果
app_id string
[]
应用方id
billing_addressobject
[]
账单地址信息
address1 string
[]
详细地址1
[]
Example: 地址1
address2 string
[]
详细地址2，备选
[]
Example: 地址2
city string
[]
城市
[]
Example: 纽约
company string
[]
公司名称
[]
Example: 新公司
country string
[]
国家
[]
Example: 美国
country_code string
[]
国家码
[]
Example: US
first_name string
[]
姓
[]
Example: Tom
last_name string
[]
名
[]
Example: Washington
name string
[]
全名
[]
Example: Tom Washington
phone string
[]
电话
[]
Example: 12756431298
province string
[]
省份
[]
Example: 加利福尼亚州
province_code string
[]
省份码
[]
Example: 4200006
zip string
[]
邮编
[]
Example: 51234
browser_ip string
[]
客户端ip
[]
Example: 157.119.232.35
cancel_reason string
[]
卖家取消原因
[]
Example: “不想买了”
cancelled_at string
[]
订单取消时间（结束）（格式见IOS8601）,2012-05-01T14:22:25-04:00
[]
Example: 2012-05-01T14:22:25-04:00
cart_token string
[]
购物车token
[]
Example: c2c4a58186b9d96395d7e6b5c2969577
checkout_id string
[]
弃单id
[]
Example: 2404785166526352972864
checkout_token string
[]
结算页token
[]
Example: 2404785166526352972864
client_detailsobject
[]
客户端详细信息
browser_ip string
[]
详细地址1
[]
Example: 157.119.232.35
session_hash string
[]
sessionId
[]
Example: 90c6724a-cf0d-4517-bd61-5c2727c2f886
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
companyobject
[]
公司信息
id string
[]
id
[]
Example: 1005619945158043247856
location_id string
[]
地点id
[]
Example: 3005619945158043247856
tax_registration_id string
[]
税号信息
[]
Example: 213213
created_at string
[]
订单创建时间（格式见IOS8601）
[]
Example: 2012-05-01T14:22:25-04:00
currency string
[]
交易币种
[]
Example: USD
current_subtotal_price string
[]
当前商品总和，商品总价*数量
[]
Example: 8.00
current_subtotal_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
[]
币种code
[]
Example: USD
current_total_discounts string
[]
折扣总和，精度2，营销优惠+人工折扣
[]
Example: 8.00
current_total_discounts_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
current_total_duties_setobject
[]
当前商品总关税
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额
[]
Example: 8.88
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额
[]
Example: 8.88
currency_code string
[]
币种
[]
Example: USD
current_total_price string
[]
税费总和，商品税 + 运费税
[]
Example: 8.00
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
current_total_tax string
[]
税费总和，商品税 + 运费税
[]
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
customerobject
[]
买家信息
addressesobject
[]
买家地址信息
address1 string
[]
详细地址1
[]
Example: 地址1
address2 string
[]
详细地址2，备选
[]
Example: 地址2
city string
[]
城市
[]
Example: 纽约
country string
[]
国家
[]
Example: 美国
country_code string
[]
国家码
[]
Example: US
first_name string
[]
姓
[]
Example: Tom
last_name string
[]
名
[]
Example: Washington
name string
[]
全名
[]
Example: Tom Washington
phone string
[]
电话
[]
Example: 12345678931
province string
[]
省份
[]
Example: 加利福尼亚州
province_code string
[]
省份码
[]
Example: 4200006
zip string
[]
邮编
[]
Example: 54123
area_code string
[]
手机区号
[]
Example: +86
created_at string
[]
买家创建时间（格式见IOS8601）
[]
Example: 2012-05-01T14:22:25-04:00
currency string
[]
币种
[]
Example: USD
email string
[]
用户邮箱
[]
Example: test1001@Gmail.com
first_name string
[]
名
[]
Example: Tom
id string
[]
用户id
[]
Example: 4201057495
last_name string
[]
姓
[]
Example: Washington
phone string
[]
用户手机号
[]
Example: 12345678931
updated_at string
[]
买家更新时间
[]
Example: 2012-05-01T14:22:25-04:00
customer_locale string
[]
买家国家，语种编码+国家名称缩写
[]
Example: enCN
deduct_member_point_amount string
[]
当前订单会员积分抵扣金额
[]
Example: 8.00
deduct_member_point_amount_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
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: explicit
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
[]
Example: 8.00
amount_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
code string
[]
优惠码
[]
Example: 1Q3UMQM8RBP5
type string
[]
优惠类型，减金额；打折；免运费；固定售价；最低价商品免费；打包价；第N件打折；
[]
Example: 减金额
email string
[]
买家邮箱,二者必有其一
[]
Example: test1001@Gmail.com
financial_status string
[]
支付状态，unpaid，authorized, pending，partially_paid，paid，partially_refunded，refunded
[]
Example: "paid"
fulfillment_status string
[]
商品的发货状态，发货状态， fulfilled-已发货; partial-部分发货； null-未发货;
[]
Example: fulfilled
fulfillmentsobject[]
[]
包裹信息
created_at string
[]
创建时间（格式见IOS8601）
[]
Example: 2012-05-01T14:22:25-04:00
id string
[]
包裹编号
[]
Example: 22046737798141702810214336
line_itemsobject[]
[]
商品列表
fulfillable_quantity integer
[]
可发货数量
[]
Example: 2
fulfillment_service string
[]
物流商名称
[]
Example: 顺丰
fulfillment_status string
[]
商品的发货状态，发货状态， fulfilled-已发货; partial-部分发货； null-未发货;
[]
Example: fulfilled
grams double
[]
重量（克）
[]
Example: 100
id string
[]
商品快照表的id, 系统生成，与订单号唯一确认一个商品
[]
Example: 231
name string
[]
sku标题,同title
[]
Example: 商品名称
price string
[]
商品售价，精度2
[]
Example: 8.00
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
product_id string
[]
spu序列号
[]
Example: 16056761559984840457934011
quantity integer
[]
订单中的商品数量
[]
Example: 2
requires_shipping boolean
[]
是否需要发货
[]
Example: true
sku string
[]
商品码，barCode
[]
Example: 18056761559987524812644011
tax_linesobject[]
[]
税费信息
price string
[]
税费，精度2
[]
Example: 8.00
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
rate double
[]
税率
[]
Example: 1
title string
[]
税费名称
[]
Example: 税费
taxable boolean
[]
是否收税
[]
Example: true
title string
[]
商品名称
[]
Example: 漂亮的裙子
variant_id string
[]
商品sku序列号
[]
Example: 18056761559987524812644011
variant_title string
[]
商品属性值, 多个以" / "分割, 如： “155 / 红色 / 大"
[]
Example: 大
vendor string
[]
供应商
[]
Example: 供应商
order_id string
[]
订单号
[]
Example: 21056577640603870897253153
shipment_status string
[]
包裹状态
[]
Example: fulfilled
status string
[]
物流配送状态， success-已发货； cancelled-已取消；
[]
Example: success
tracking_company string
[]
物流公司名称
[]
Example: 顺丰国际
tracking_number string
[]
第三方物流单号
[]
Example: SF10122233322222
tracking_url string
[]
物流公司url
[]
Example: https://www.sf-international.com/
updated_at string
[]
更新时间（格式见IOS8601）
[]
Example: 2012-05-01T14:22:25-04:00
id string
[]
订单号，系统自定义编号
[]
Example: 21050224312121887324667162
line_itemsobject[]
[]
订单商品快照信息
country_code_of_origin 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
dutiesobject[]
[]
关税信息
country_code_of_origin string
[]
原产地/发货地的国家代码
harmonized_system_code string
[]
海关编码
id string
[]
关税编号
priceobject
[]
关税多币种信息
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额
[]
Example: 8.88
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额
[]
Example: 8.88
currency_code string
[]
币种
[]
Example: USD
tax_linesobject[]
[]
税费明细列表
price_setobject
[]
税费多币种信息
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额
[]
Example: 8.88
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额
[]
Example: 8.88
currency_code string
[]
币种
[]
Example: USD
rate double
[]
税率
rate_percentage double
[]
税率(百份比的值，即rate * 100)
title string
[]
税费标题
fulfillable_quantity integer
[]
可发货数量
[]
Example: 2
fulfillment_service string
[]
物流商名称
[]
Example: 顺丰国际
fulfillment_status string
[]
商品的发货状态，发货状态， fulfilled-已发货; partial-部分发货； null-未发货;
[]
Example: Fulfilled
gift_card boolean
[]
是否为礼品卡商品
[]
Example: true
grams double
[]
重量（克）
[]
Example: 100
harmonized_system_code string
[]
协调制度代码
[]
Example: 协调制度代码
id string
[]
商品快照表的id, 系统生成，与订单号唯一确认一个商品
[]
Example: 413
location_id string
[]
pos场景下店铺对应的地点
[]
Example: 5327026538935748524
name string
[]
sku标题,同title
[]
Example: 商品标题
price string
[]
商品售价，精度2
[]
Example: 8.00
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
product_id string
[]
spu序列号
[]
Example: 16056761559984840457934011
quantity integer
[]
订单中的商品数量
[]
Example: 2
requires_shipping boolean
[]
是否需要发货
[]
Example: true
sku string
[]
商品码，barCode
[]
Example: 18056761559987524812644011
tax_linesobject[]
[]
税费信息
price string
[]
税费，精度2
[]
Example: 8.00
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
rate double
[]
税率
[]
Example: 1
title string
[]
税费名称
[]
Example: 税费
type string
[]
税费用类型，用于区分是商品税还是运费税，枚举值如下 product_tax：商品税 shipping_tax：运费税
[]
Example: shipping_tax
taxable boolean
[]
是否收税
[]
Example: true
title string
[]
商品标题
[]
Example: 好看的裙子
variant_id string
[]
商品sku序列号
[]
Example: 18056761559987524812644011
variant_title string
[]
商品属性值, 多个以" / "分割, 如： “155 / 红色 / 大"
[]
Example: 大
vendor string
[]
供应商
[]
Example: 供应商
name string
[]
自定义订单号
[]
Example: test1001
note string
[]
商家备注内容
[]
Example: 商家备注
note_attributesobject[]
[]
商家备注日志，日期内容
create_time string
[]
备注创建时间（格式见IOS8601）
[]
Example: 2012-05-01T14:22:25-04:00
name string
[]
备注来源（卖家标识）
[]
Example: 备注来源
value string
[]
备注内容
[]
Example: 备注内容
order_source string
[]
订单来源渠道
[]
Example: pos
order_status_url string
[]
订单状态页url
[]
Example: https://shoptest.myshoplinestg.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509
payment_detailsobject[]
[]
支付单信息
create_time string
[]
支付单创建时间（格式见IOS8601）
[]
Example: 2012-05-01T14:22:25-04:00
order_seq string
[]
订单号
[]
Example: 23057287797738260472676128
pay_amount double
[]
支付金额
[]
Example: 8.23
pay_channel_deal_id string
[]
外部渠道支付流水号
[]
Example: pi_3MI897Hezv8FxjBO1uGxMPhX
pay_seq string
[]
支付单号
[]
Example: 23057287797738260472676128
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
status_code string
[]
支付状态码
[]
Example: RISK_PENDING
status_msg string
[]
支付单状态码描述
[]
Example: PENDING_REVIEW
payment_gateway_names array
[]
付款方式列表,该订单所用到的付款方式列表, SLpayments ,Paypal(PayPal支付), Oceanpay(钱海支付), TwoCheckout,AsiaBill, Stripe,Pacypay, WorldPay, COD（货到付款), CUSTOM(自定义), adjustPay（资金调整）, Xendit(xendit信用卡), XenditOther
[]
Example: PayPal
phone string
[]
买家联系方式，二者必有其一
[]
Example: 12903001000
presentment_currency string
[]
买家侧币种,同卖家侧币种
[]
Example: USD
processed_at string
[]
processed_at 成单时间,格式：2023-04-12T22:59:52+08:00
[]
Example: 2023-04-12T22:59:52+08:00
processed_user_id string
[]
订单创建者
[]
Example: 4201057495
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-01T14:22:25-04:00
refund_line_itemsobject[]
[]
退款详细信息
id string
[]
退款单号
[]
Example: 2605659027312156877634
line_itemobject
[]
退款商品行
fulfillable_quantity integer
[]
可发货数量
[]
Example: 1
fulfillment_service string
[]
物流商名称
[]
Example: 顺丰国际
fulfillment_status string
[]
商品的发货状态，发货状态， fulfilled-已发货; partial-部分发货； null-未发货;
[]
Example: fulfilled
grams double
[]
重量（克）
[]
Example: 100
id string
[]
商品快照表的id, 系统生成，与订单号唯一确认一个商品
[]
Example: 403
name string
[]
sku标题,同title
[]
Example: test-002
price string
[]
商品售价，精度2
[]
Example: 3.25
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
product_id string
[]
spu序列号
[]
Example: 16056761559984840457934011
quantity integer
[]
订单中的商品数量
[]
Example: 1
requires_shipping boolean
[]
是否需要发货
sku string
[]
商品码，barCode
[]
Example: 18056761559987524812644011
tax_linesobject[]
[]
税费信息
price string
[]
税费，精度2
[]
Example: 8.00
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
rate double
[]
税率
[]
Example: 1
title string
[]
税费名称
[]
Example: 商品稅
taxable boolean
[]
是否收税
title string
[]
商品标题
[]
Example: 好看的裙子
variant_id string
[]
商品sku序列号
[]
Example: 18056761559987524812644011
variant_title string
[]
商品属性值, 多个以" / "分割, 如： “155 / 红色 / 大"
[]
Example: 大
vendor string
[]
供应商
[]
Example: 供应商
line_item_id string
[]
商品快照表的id, 系统生成，与订单号唯一确认一个商品
[]
Example: 302
quantity integer
[]
数量,商品数量
[]
Example: 1
restock_type string
[]
库存返还类型,no_restock-未返还，cancel-取消， return-返还只有未返还
[]
Example: no_restock
subtotal double
[]
退款金额合计，精度2
[]
Example: 8
subtotal_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_tax double
[]
退款商品的税额，精度2
[]
Example: 7
total_tax_setobject
[]
总税额，多币种信息
presentment_moneyobject
[]
买家侧币种信息
amount string
[]
金额
[]
Example: 7.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧币种信息
amount string
[]
金额
[]
Example: 7.00
currency_code string
[]
币种
[]
Example: USD
transactionsobject[]
[]
退款交易信息
amount string
[]
金额
[]
Example: 8.00
created_at string
[]
创建时间（格式见IOS8601）
[]
Example: 2012-05-01T14:22:25-04:00
currency string
[]
币种
[]
Example: USD
id string
[]
退款id
[]
Example: 2605659027312156877634
kind string
[]
交易类型（authorization， capture， sale， void， refund）
[]
Example: authorization
order_id string
[]
订单号
[]
Example: 21056577640603870897253153
processed_at string
[]
更新时间（格式见IOS8601）
[]
Example: 2012-05-01T14:22:25-04:00
status string
[]
处理状态, pending, failure, success, and error
[]
Example: pending
user_id string
[]
买家id
[]
Example: 4201057495
user_id string
[]
用户id
[]
Example: 4201057495
shipping_addressobject
[]
收货地址
address1 string
[]
详细地址1
[]
Example: 地址1
address2 string
[]
详细地址2，备选
[]
Example: 地址2
city string
[]
城市
[]
Example: 纽约
company string
[]
公司名称
[]
Example: 新公司
country string
[]
国家
[]
Example: 美国
country_code string
[]
国家码
[]
Example: US
first_name string
[]
名
[]
Example: Tom
last_name string
[]
姓
[]
Example: Washington
latitude string
[]
纬度
[]
Example: 45
longitude string
[]
经度
[]
Example: 31
name string
[]
全名
[]
Example: Tom Washington
phone string
[]
电话
[]
Example: 13100000000
province string
[]
省份
[]
Example: 加利福尼亚州
province_code string
[]
省份码
[]
Example: 4200006
zip string
[]
邮编
[]
Example: 92503
shipping_linesobject[]
[]
物流信息
code string
[]
物流编号
[]
Example: SF123332435364
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
[]
Example: 8.00
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
price string
[]
物流运费,精度2
[]
Example: 8.00
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
requested_fulfillment_service_id string
[]
运输服务代号
[]
Example: LX88888
shipping_price string
[]
原运费金额值（非折扣后金额）
[]
Example: 8.00
shipping_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
source string
[]
运费来源
[]
Example: SHOPLINE
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
[]
金额
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
rate double
[]
税率
[]
Example: 1
title string
[]
税费名称
[]
Example: 税费
title string
[]
物流名称
[]
Example: 顺丰国际
store_id string
[]
店铺id
[]
Example: 1644828244663
subtotal_price string
[]
商品折后价总和, 商品总价 - 营销优惠 - 人工折扣
[]
Example: 8.00
subtotal_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
tags string
[]
订单标签
[]
Example: 标签
tax_linesobject[]
[]
税费信息
price string
[]
税费金额，精度2
[]
Example: 8.00
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
rate double
[]
税率
[]
Example: 1
title string
[]
税费名称
[]
Example: 税费
tax_number string
[]
税号
[]
Example: 11111111
tax_type string
[]
税号类型
[]
Example: 类型
taxes_included boolean
[]
总计额是否包含税额
[]
Example: true
total_discounts string
[]
折扣总额，营销优惠+人工折扣
[]
Example: 8.00
total_discounts_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
total_line_items_price string
[]
商品原价总和，精度2
total_line_items_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
total_outstanding string
[]
未付款金额总和，精度2
[]
Example: 金额金额
total_outstanding_setobject
[]
未付款金额总和，多币种信息
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额
[]
Example: 金额
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额
[]
Example: 金额
currency_code string
[]
币种
[]
Example: USD
total_shipping_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
total_tax string
[]
税费总和，精度2, 商品税 + 运费税
[]
Example: 8.00
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
total_tip_received string
[]
小费，精度2
[]
Example: 8.00
total_tip_received_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
total_weight double
[]
商品总重量（g）
[]
Example: 100
updated_at string
[]
订单更新时间（格式见IOS8601）
[]
Example: 2012-05-01T14:22:25-04:00
user_id string
[]
买家id
[]
Example: 4201057495

API Explorer

调试台

Base URL

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

ParamOptions

id — path required

Authorization — header required

Body

Body required

{
  "amount": 100,
  "cancel_reason": "\"不想买了\"",
  "currency": "\"CNY\"",
  "email": true,
  "processed_at": "2023-04-12T22:59:52+08:00",
  "restock": true
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/orders/id/cancel.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json' \
     --data '
{
  "amount": 100,
  "cancel_reason": "\"不想买了\"",
  "currency": "\"CNY\"",
  "email": true,
  "processed_at": "2023-04-12T22:59:52+08:00",
  "restock": true
}
'

这篇文章对你有帮助吗？

SHOPLINE

条款协议

Error loading component.