取消订单

需要 write_orders 权限点。
更多权限点使用信息，请参考：
访问权限。
POST https://{handle}.myshopline.com/admin/openapi/v20261201/orders/:id/cancel.json
handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。
取消订单
路径参数
  • id string required
    订单号
    例子: "21050342939778451436179579"
请求头
  • Content-Type string required
    字段值固定为 application/json; charset=utf-8。
  • Authorization string required
    资源的访问令牌。参考 应用授权 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
    例子:
    Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA
请求体
  • email boolean
    是否发送邮件
    例子: true
  • processed_at string
    取消订单实际发生时间
    例子: 2023-04-12T22:59:52+08:00
  • refund_type string
    退款类型：
    • OriginalPayment Refund：原路退款
    • Manual：手动标记退款
    当支付渠道为Paypal，不传时默认值为：OriginalPayment Refund。其他支付渠道默认值：Manual。
  • restock boolean
    库存是否回退 ture:库存回退 false和空字段为不回退库存
    例子: true
  • amount double
    金额
    例子: 100
  • cancel_reason string
    取消原因
    例子: " don ' t want to buy "
  • currency string
    币种
    例子: "CNY"
状态码
更多状态码信息，参考 HTTP 状态码。
响应头
  • traceId
    请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。
响应体
  • orderobject
    订单信息,字段描述、示例请参考订单列表响应结果
  • current_subtotal_price_setobject
    当前商品总和多币种信息， 买卖家币种和金额一致
  • presentment_moneyobject
    买家侧币种
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧金额
  • amount string
    金额，精度2
    例子: 8.00
  • currency_code string
    币种code
    例子: USD
  • current_total_discounts_setobject
  • presentment_moneyobject
    买家侧金额
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种信息
    例子: USD
  • shop_moneyobject
    卖家侧金额
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • financial_status string
    支付状态，unpaid，authorized, pending，partially_paid，paid，partially_refunded，refunded
    例子: "paid"
  • total_tip_received_setobject
    小费，多币种信息
  • presentment_moneyobject
    买家侧币种信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧币种信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • current_total_price string
    订单总额，以店铺币种金额展示。
    例子: 8.00
  • current_total_tax_setobject
    税费总和多币种信息， 买卖家币种和金额一致
  • presentment_moneyobject
    买家侧币种
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧币种
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • discount_codesobject[]
    优惠码信息
  • code string
    优惠码
    例子: 1Q3UMQM8RBP5
  • type string
    优惠类型，减金额；打折；免运费；固定售价；最低价商品免费；打包价；第N件打折；
    例子: Reduction amount
  • amount string
    优惠金额,精度2
    例子: 8.00
  • amount_setobject
    优惠金额，多币种信息
  • presentment_moneyobject
    买家侧币种
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧币种
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • payment_detailsobject[]
    支付单信息
  • order_seq string
    订单号
    例子: 23057287797738260472676128
  • pay_amount double
    支付金额
    例子: 8.23
  • pay_status string
    支付单状态, unpaid-未支付；pending-支付中；risking-风控中；paid-已支付；paid_overtime-支付失败；paid_failed-支付失败；
    例子: unpaid
  • status_msg string
    支付单状态码描述
    例子: PENDING_REVIEW
  • create_time string
    支付单创建时间（格式见IOS8601）
    例子: 2012-05-01T14:22:25-04:00
  • pay_channel_deal_id string
    外部渠道支付流水号
    例子: pi_3MI897Hezv8FxjBO1uGxMPhX
  • pay_seq string
    支付单号
    例子: 23057287797738260472676128
  • processed_at string
    支付创建时间,格式：2023-04-12T22:59:52+08:00
    例子: 2023-04-12T22:59:52+08:00
  • status_code string
    支付状态码
    例子: RISK_PENDING
  • store_id string
    店铺id
    例子: 1644828244663
  • tax_linesobject[]
    税费信息
  • rate double
    税率
    例子: 1
  • title string
    税费名称
    例子: taxes
  • price string
    税费金额，精度2
    例子: 8.00
  • price_setobject
    税费多币种信息
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • tax_number string
    税号
    例子: 11111111
  • taxes_included boolean
    总计额是否包含税额
    例子: true
  • total_discounts string
    折扣总额，营销优惠+人工折扣
    例子: 8.00
  • current_subtotal_price string
    当前商品总和，商品总价*数量
    例子: 8.00
  • fulfillmentsobject[]
    包裹信息
  • created_at string
    创建时间（格式见IOS8601）
    例子: 2012-05-01T14:22:25-04:00
  • id string
    包裹编号
    例子: 22046737798141702810214336
  • order_id string
    订单号
    例子: 21056577640603870897253153
  • shipment_status string
    包裹状态
    例子: fulfilled
  • tracking_company string
    物流公司名称
    例子: SF International
  • tracking_number string
    第三方物流单号
    例子: SF10122233322222
  • line_itemsobject[]
    商品列表
  • price_setobject
    商品售价，多币种信息
  • presentment_moneyobject
    买家侧币种
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧币种
  • currency_code string
    币种
    例子: USD
  • amount string
    金额
    例子: 8.00
  • product_id string
    spu序列号
    例子: 16056761559984840457934011
  • requires_shipping boolean
    是否需要发货
    例子: true
  • taxable boolean
    是否收税
    例子: true
  • tax_linesobject[]
    税费信息
  • price string
    税费，精度2
    例子: 8.00
  • price_setobject
    税费多币种信息
  • presentment_moneyobject
    买家侧金额
  • amount string
    描金额述
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧金额信息
  • currency_code string
    币种
    例子: USD
  • amount string
    金额
    例子: 8.00
  • rate double
    税率
    例子: 1
  • title string
    税费名称
    例子: taxes
  • fulfillment_status string
    商品的发货状态， 发货状态， fulfilled-已发货; partial-部分发货； null-未发货;
    例子: fulfilled
  • grams double
    重量（克）
    例子: 100
  • id string
    商品快照表的id, 系统生成，与订单号唯一确认一个商品
    例子: 231
  • sku string
    商品码，barCode
    例子: 18056761559987524812644011
  • variant_id string
    商品sku序列号
    例子: 18056761559987524812644011
  • variant_title string
    商品属性值, 多个以" / "分割, 如： “155 / 红色 / 大"
    例子: big
  • name string
    sku标题,同title
    例子: Product name
  • title string
    商品名称
    例子: Nice looking skirt
  • vendor string
    供应商
    例子: Supplier
  • fulfillable_quantity integer
    可发货数量
    例子: 2
  • fulfillment_service string
    物流商名称
    例子: SF International
  • price string
    商品售价，精度2
    例子: 8.00
  • quantity integer
    订单中的商品数量
    例子: 2
  • status string
    物流配送状态， success-已发货； cancelled-已取消；
    例子: success
  • tracking_info_listobject[]
    物流追踪信息列表，若指定该入参，则单个入参的tracking_url、tracking_number、tracking_company被拦截。最多传入 10 个追踪信息。
  • tracking_company string
    物流服务商。
  • tracking_number string
    物流单号。
  • tracking_url string
    追踪链接。
  • tracking_url string
    物流公司url
    例子: https://www.sf-international.com/
  • updated_at string
    更新时间（格式见IOS8601）
    例子: 2012-05-01T14:22:25-04:00
  • id string
    订单号，系统自定义编号
    例子: 21050224312121887324667162
  • checkout_token string
    结算页token
    例子: 2404785166526352972864
  • currency string
    交易币种
    例子: USD
  • current_total_discounts string
    折扣总和，精度2，营销优惠+人工折扣
    例子: 8.00
  • email string
    买家邮箱,二者必有其一
    例子: test1001@Gmail.com
  • order_status_url string
    订单状态页url
    例子: https://shoptest.myshoplinestg.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509
  • presentment_currency string
    买家侧币种,同卖家侧币种
    例子: USD
  • shipping_addressobject
    收货地址
  • standard_province_code string
    地址中省份的编码，该编码为二位的 ISO 3166-2 国际编码，区别于province_code返参为自定义编码。
  • zip string
    邮编
    例子: 92503
  • address2 string
    详细地址2，备选
    例子: address2
  • longitude string
    经度
    例子: 31
  • city string
    城市
    例子: New York
  • last_name string
    姓
    例子: Washington
  • address1 string
    详细地址1
    例子: address1
  • company string
    公司名称
    例子: New company
  • country_code string
    国家码
    例子: US
  • province_code string
    省份码
    例子: 4200006
  • country string
    国家
    例子: US
  • first_name string
    名
    例子: Tom
  • latitude string
    纬度
    例子: 45
  • name string
    全名
    例子: Tom Washington
  • phone string
    电话
    例子: 13100000000
  • province string
    省份
    例子: California
  • shipping_linesobject[]
    物流信息
  • tax_linesobject[]
    物流征税列表
  • price string
    税费
    例子: 8.00
  • price_setobject
    税费多币种信息
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    店铺侧金额信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • rate double
    税率
    例子: 1
  • title string
    税费名称
    例子: taxes
  • code string
    物流编号
    例子: SF123332435364
  • discounted_price string
    折扣金额，精度2
    例子: 8.00
  • discounted_price_setobject
    折扣多币种金额
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额，精度2
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    店铺侧金额信息
  • currency_code string
    币种
    例子: USD
  • amount string
    金额，精度2
    例子: 8.00
  • shipping_price_setobject
    原运费金额值（非折扣后金额），多币种信息
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • source string
    运费来源
    例子: SHOPLINE
  • title string
    物流名称
    例子: SF International
  • discount_allocationsobject[]
    折扣明细
  • amount string
    折扣金额，精度2
    例子: 8.00
  • amount_setobject
    折扣多币种金额
  • presentment_moneyobject
    买家侧金额信息
  • currency_code string
    币种
    例子: USD
  • amount string
    金额，精度2
    例子: 8.00
  • shop_moneyobject
    店铺侧金额信息
  • amount string
    金额，精度2
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • discount_application_index integer
    折扣索引信息：标明在折扣明细中的位置
    例子: 1
  • price string
    物流运费,精度2
    例子: 8.00
  • price_setobject
    物流运费多资源信息
  • presentment_moneyobject
    买家侧金额信息
  • currency_code string
    币种
    例子: USD
  • amount string
    金额
    例子: 8.00
  • shop_moneyobject
    店铺侧金额信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • requested_fulfillment_service_id string
    运输服务代号
    例子: LX88888
  • shipping_price string
    原运费金额值（非折扣后金额）
    例子: 8.00
  • total_discounts_setobject
    折扣总额多币种信息
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • total_outstanding_setobject
    未付款金额总和，多币种信息
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • created_at string
    订单创建时间（格式见IOS8601）
    例子: 2012-05-01T14:22:25-04:00
  • current_total_duties_setobject
    当前商品总关税
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额
    例子: 8.88
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额
    例子: 8.88
  • currency_code string
    币种
    例子: USD
  • line_itemsobject[]
    订单商品快照信息
  • fulfillable_quantity integer
    可发货数量
    例子: 2
  • gift_card boolean
    是否为礼品卡商品
    例子: true
  • grams double
    重量（克）
    例子: 100
  • harmonized_system_code string
    协调制度代码
    例子: harmonized system code
  • price string
    商品售价，精度2
    例子: 8.00
  • requires_shipping boolean
    是否需要发货
    例子: true
  • sku string
    商品码，barCode
    例子: 18056761559987524812644011
  • discount_allocationsobject[]
    营销折扣明细金额多币种
  • amount_setobject
    折扣明细金额多币种
  • presentment_moneyobject
    支付币种
  • amount string
    金额，精度2
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    店铺币种
  • amount string
    金额，精度2
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • discount_application_index integer
    折扣索引信息：标明在折扣明细中的位置
    例子: 1
  • amount string
    折扣明细金额
    例子: 8.00
  • id string
    商品快照表的id, 系统生成，与订单号唯一确认一个商品
    例子: 413
  • location_id string
    pos场景下店铺对应的地点
    例子: 5327026538935748524
  • name string
    sku标题,同title
    例子: Product name
  • quantity integer
    订单中的商品数量
    例子: 2
  • title string
    商品标题
    例子: Nice looking skirt
  • fulfillment_service string
    物流商名称
    例子: SF International
  • fulfillment_status string
    商品的发货状态， 发货状态， fulfilled-已发货; partial-部分发货； null-未发货;
    例子: Fulfilled
  • product_id string
    spu序列号
    例子: 16056761559984840457934011
  • tax_linesobject[]
    税费信息
  • price string
    税费，精度2
    例子: 8.00
  • price_setobject
    税费多币种信息
  • presentment_moneyobject
    买家侧币种信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧币种信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • rate double
    税率
    例子: 1
  • title string
    税费名称
    例子: taxes
  • type string
    税费用类型，用于区分是商品税还是运费税，枚举值如下 product_tax：商品税 shipping_tax：运费税
    例子: shipping_tax
  • variant_title string
    商品属性值, 多个以" / "分割, 如： “155 / 红色 / 大"
    例子: big
  • dutiesobject[]
    关税信息
  • tax_linesobject[]
    税费明细列表
  • price_setobject
    税费多币种信息
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额
    例子: 8.88
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额
    例子: 8.88
  • currency_code string
    币种
    例子: USD
  • rate double
    税率
  • rate_percentage double
    税率(百份比的值，即rate * 100)
  • title string
    税费标题
  • country_code_of_origin string
    原产地/发货地的国家代码
  • harmonized_system_code string
    海关编码
  • id string
    关税编号
  • priceobject
    关税多币种信息
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额
    例子: 8.88
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额
    例子: 8.88
  • currency_code string
    币种
    例子: USD
  • price_setobject
    商品售价，多币种信息
  • presentment_moneyobject
    买家侧币种
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧币种
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • taxable boolean
    是否收税
    例子: true
  • variant_id string
    商品sku序列号
    例子: 18056761559987524812644011
  • vendor string
    供应商
    例子: Supplier
  • country_code_of_origin string
    原产地国家
    例子: Country of origin
  • note string
    商家备注内容
    例子: Merchant notes
  • note_attributesobject[]
    商家备注日志，日期内容
  • name string
    备注来源（卖家标识）
    例子: Note source
  • value string
    备注内容
    例子: Note source
  • create_time string
    备注创建时间（格式见IOS8601）
    例子: 2012-05-01T14:22:25-04:00
  • tags string
    订单标签
    例子: Label
  • app_id string
    应用方id
  • name string
    自定义订单号
    例子: test1001
  • total_tax string
    税费总和，精度2, 商品税 + 运费税
    例子: 8.00
  • cart_token string
    购物车token
    例子: c2c4a58186b9d96395d7e6b5c2969577
  • customerobject
    买家信息
  • addressesobject
    买家地址信息
  • phone string
    电话
    例子: 12345678931
  • province string
    省份
    例子: California
  • province_code string
    省份码
    例子: 4200006
  • city string
    城市
    例子: New York
  • country string
    国家
    例子: US
  • country_code string
    国家码
    例子: US
  • first_name string
    姓
    例子: Tom
  • last_name string
    名
    例子: Washington
  • name string
    全名
    例子: Tom Washington
  • zip string
    邮编
    例子: 54123
  • address1 string
    详细地址1
    例子: address1
  • address2 string
    详细地址2，备选
    例子: address2
  • area_code string
    手机区号
    例子: +86
  • first_name string
    名
    例子: Tom
  • last_name string
    姓
    例子: Washington
  • phone string
    用户手机号
    例子: 12345678931
  • created_at string
    买家创建时间（格式见IOS8601）
    例子: 2012-05-01T14:22:25-04:00
  • currency string
    币种
    例子: USD
  • email string
    用户邮箱
    例子: test1001@Gmail.com
  • id string
    用户id
    例子: 4201057495
  • updated_at string
    买家更新时间
    例子: 2012-05-01T14:22:25-04:00
  • phone string
    买家联系方式，二者必有其一
    例子: 12903001000
  • subtotal_price_setobject
    商品折后价总和多币种信息
  • shop_moneyobject
    店铺侧金额信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • customer_locale string
    买家国家，语种编码+国家名称缩写
    例子: enCN
  • fulfillment_status string
    商品的发货状态， 发货状态， fulfilled-已发货; partial-部分发货； null-未发货;
    例子: fulfilled
  • order_source string
    订单来源渠道
    例子: pos
  • subtotal_price string
    商品折后价总和, 商品总价 - 营销优惠 - 人工折扣
    例子: 8.00
  • tax_type string
    税号类型
    例子: Type
  • total_line_items_price_setobject
    商品原价总和，多币种信息
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • total_shipping_price_setobject
    订单运费总和，多币种信息
  • presentment_moneyobject
    买家侧金额信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧金额信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • discount_applicationsobject[]
    该订单应用的所有折扣信息
  • allocation_method string
    活动的折扣应用范围 1）across（该值分布在所有授权行中） 2）each（该值应用于每个授权行）
    例子: across
  • code string
    活动的具体描述
    例子: 1Q3UMQM8RBP5
  • value string
    活动的折扣值
    例子: 20
  • description string
    活动的具体描述
    例子: Description
  • target_selection string
    活动的折扣应用具体对象 1）explicit（折扣分配到明确选择的商品行或运费行） 2）all（折扣分配到所有商品行或运费行） 3）ENTITLED（折扣仅分配到其有权使用的商品行或运费行）
    例子: explicit
  • target_type string
    活动的折扣应用对象 1）line_item 2）shipping_line
    例子: line_item
  • title string
    活动的具体描述
    例子: Description
  • type string
    活动折扣类型 1）manual（自定义类型） 2）automatic（自动折扣类型） 3）discount_code（折扣码类型）
    例子: manual
  • value_type string
    活动的折扣值类型，包含百分比和固定金额两类
    例子: fixed_amount
  • processed_at string
    processed_at 成单时间,格式：2023-04-12T22:59:52+08:00
    例子: 2023-04-12T22:59:52+08:00
  • user_id string
    买家id
    例子: 4201057495
  • browser_ip string
    客户端ip
    例子: 157.119.232.35
  • cancel_reason string
    卖家取消原因
    例子: " don ' t want to buy "
  • client_detailsobject
    客户端详细信息
  • browser_ip string
    详细地址1
    例子: 157.119.232.35
  • session_hash string
    sessionId
    例子: 90c6724a-cf0d-4517-bd61-5c2727c2f886
  • user_agent string
    客户端代理
    例子: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Sa
  • current_total_tax string
    税费总和，商品税 + 运费税
    例子: 8.00
  • deduct_member_point_amount_setobject
    当前订单会员积分抵扣金额，多币种信息
  • shop_moneyobject
    卖家侧币种
  • currency_code string
    币种
    例子: USD
  • amount string
    金额
    例子: 8.00
  • presentment_moneyobject
    买家侧币种
  • currency_code string
    币种
    例子: USD
  • amount string
    金额
    例子: 8.00
  • processed_user_id string
    订单创建者
    例子: 4201057495
  • total_weight double
    商品总重量（g）
    例子: 100
  • cancelled_at string
    订单取消时间（结束）（格式见IOS8601）,2012-05-01T14:22:25-04:00
    例子: 2012-05-01T14:22:25-04:00
  • companyobject
    公司信息
  • id string
    id
    例子: 1005619945158043247856
  • location_id string
    地点id
    例子: 3005619945158043247856
  • tax_registration_id string
    税号信息
    例子: 213213
  • payment_gateway_names array
    付款方式列表,该订单所用到的付款方式列表, SLpayments ,Paypal(PayPal支付), Oceanpay(钱海支付), TwoCheckout,AsiaBill, Stripe,Pacypay, WorldPay, COD（货到付款), CUSTOM(自定义), adjustPay（资金调整）, Xendit(xendit信用卡), XenditOther
    例子: ["PayPal"]
  • total_line_items_price string
    商品原价总和，精度2
  • total_outstanding string
    未付款金额总和，精度2
    例子: Amount
  • total_tip_received string
    小费，精度2
    例子: 8.00
  • updated_at string
    订单更新时间（格式见IOS8601）
    例子: 2012-05-01T14:22:25-04:00
  • billing_addressobject
    账单地址信息
  • last_name string
    名
    例子: Washington
  • name string
    全名
    例子: Tom Washington
  • phone string
    电话
    例子: 12756431298
  • standard_province_code string
    账单地址中省份的编码，该编码为二位的 ISO 3166-2 国际编码，区别于province_code返参为自定义编码。
  • city string
    城市
    例子: New York
  • company string
    公司名称
    例子: New company
  • country_code string
    国家码
    例子: US
  • province string
    省份
    例子: California
  • province_code string
    省份码
    例子: 4200006
  • zip string
    邮编
    例子: 51234
  • address1 string
    详细地址1
    例子: address1
  • address2 string
    详细地址2，备选
    例子: address2
  • country string
    国家
    例子: US
  • first_name string
    姓
    例子: Tom
  • deduct_member_point_amount string
    当前订单会员积分抵扣金额
    例子: 8.00
  • total_tax_setobject
    税费总和，多币种信息
  • presentment_moneyobject
    买家侧币种信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧币种信息
  • currency_code string
    金额
    例子: USD
  • amount string
    币种
    例子: 8.00
  • checkout_id string
    弃单id
    例子: 2404785166526352972864
  • current_total_price_setobject
    订单总额，分别以买家币种金额和店铺币种金额展示。
  • presentment_moneyobject
    展示给买家的订单价格信息。
  • amount string
    订单总额，数值保留到小数点后两位。
    例子: 8.00
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    例子: USD
  • shop_moneyobject
    商家侧记录的订单价格信息。
  • amount string
    订单总额，数值保留到小数点后两位。
    例子: 8.00
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    例子: USD
  • refundsobject[]
    退款列表
  • transactionsobject[]
    退款交易信息
  • created_at string
    创建时间（格式见IOS8601）
    例子: 2012-05-01T14:22:25-04:00
  • currency string
    币种
    例子: USD
  • kind string
    交易类型（authorization， capture， sale， void， refund）
    例子: authorization
  • processed_at string
    更新时间（格式见IOS8601）
    例子: 2012-05-01T14:22:25-04:00
  • user_id string
    买家id
    例子: 4201057495
  • amount string
    金额
    例子: 8.00
  • id string
    退款id
    例子: 2605659027312156877634
  • order_id string
    订单号
    例子: 21056577640603870897253153
  • status string
    处理状态, pending, failure, success, and error
    例子: pending
  • user_id string
    用户id
    例子: 4201057495
  • created_at string
    退款单创建时间 （格式见IOS8601）
    例子: 2012-05-01T14:22:25-04:00
  • id string
    退款id
    例子: 2605659027312156877634
  • note string
    退款备注
    例子: Refund Notes
  • order_id string
    订单号
    例子: 21056577640603870897253153
  • processed_at string
    更新时间 （格式见IOS8601）
    例子: 2012-05-01T14:22:25-04:00
  • refund_line_itemsobject[]
    退款详细信息
  • id string
    退款单号
    例子: 2605659027312156877634
  • line_item_id string
    商品快照表的id, 系统生成，与订单号唯一确认一个商品
    例子: 302
  • quantity integer
    数量,商品数量
    例子: 1
  • restock_type string
    库存返还类型,no_restock-未返还，cancel-取消， return-返还 只有未返还
    例子: no_restock
  • subtotal double
    退款金额合计，精度2
    例子: 8
  • subtotal_setobject
    退款金额合计，多币种信息，卖家和买家侧相同
  • presentment_moneyobject
    买家侧币种信息
  • amount string
    金额
    例子: 3.25
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧币种信息
  • amount string
    金额
    例子: 3.25
  • currency_code string
    币种
    例子: USD
  • total_tax_setobject
    总税额，多币种信息
  • presentment_moneyobject
    买家侧币种信息
  • amount string
    金额
    例子: 7.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧币种信息
  • amount string
    金额
    例子: 7.00
  • currency_code string
    币种
    例子: USD
  • line_itemobject
    退款商品行
  • title string
    商品标题
    例子: Nice looking skirt
  • vendor string
    供应商
    例子: Supplier
  • fulfillment_status string
    商品的发货状态， 发货状态， fulfilled-已发货; partial-部分发货； null-未发货;
    例子: fulfilled
  • id string
    商品快照表的id, 系统生成，与订单号唯一确认一个商品
    例子: 403
  • price string
    商品售价，精度2
    例子: 3.25
  • variant_id string
    商品sku序列号
    例子: 18056761559987524812644011
  • taxable boolean
    是否收税
  • price_setobject
    商品售价，多币种信息
  • presentment_moneyobject
    买家侧币种
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧币种
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • product_id string
    spu序列号
    例子: 16056761559984840457934011
  • quantity integer
    订单中的商品数量
    例子: 1
  • sku string
    商品码，barCode
    例子: 18056761559987524812644011
  • tax_linesobject[]
    税费信息
  • rate double
    税率
    例子: 1
  • title string
    税费名称
    例子: taxes
  • price string
    税费，精度2
    例子: 8.00
  • price_setobject
    税费多币种信息
  • presentment_moneyobject
    买家侧币种信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • shop_moneyobject
    卖家侧币种信息
  • amount string
    金额
    例子: 8.00
  • currency_code string
    币种
    例子: USD
  • variant_title string
    商品属性值, 多个以" / "分割, 如： “155 / 红色 / 大"
    例子: big
  • fulfillable_quantity integer
    可发货数量
    例子: 1
  • fulfillment_service string
    物流商名称
    例子: SF International
  • grams double
    重量（克）
    例子: 100
  • name string
    sku标题,同title
    例子: test-002
  • requires_shipping boolean
    是否需要发货
  • total_tax double
    退款商品的税额，精度2
    例子: 7
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201

ParamOptions

— path required
— header required

Body

required
{
  "amount": 100,
  "cancel_reason": "\" don ' t want to buy \"",
  "currency": "\"CNY\"",
  "email": true,
  "processed_at": "2023-04-12T22:59:52+08:00",
  "refund_type": null,
  "restock": true
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/orders/id/cancel.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
这篇文章对你有帮助吗？
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
条款协议
隐私
条款
开发者协议
LinkedInEmail
LinkedInEmail
© Copyright 2013-2026 SHOPLINE Limited.