更新订单
PUT https://{handle}.myshopline.com/admin/openapi/v20220901/orders/:id.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
请求体
orderobject
订单对象id string订单号note_attributesobject[]
附加信息name string名称value string值tags string订单标签,多个以英文逗号分割Example:xternal, Inbound, Outbound
响应
- 200
- 401
- 429
更多状态码信息请参考 HTTP 状态码
响应头
traceId
traceId
响应体
orderobject
订单信息,字段描述、示例请参考订单列表响应结果app_id string应用方idbilling_addressobject
账单地址address1 string账单收件人详细地址(最大255个字符)address2 string账单收件人详细地址附加(最大255个字符)city string账单收件人城市(最大64个字符)company string公司名称country string账单收件人国家(最大64个字符)country_code string账单收件人国家编码first_name string账单收件人名last_name string账单收件人姓name string账单收件姓名phone string账单收件人名手机号province string账单收件人名省份province_code string账单收件人名省份编码zip string账单收件人名邮编browser_ip string客户端ipcancel_reason string卖家取消原因cancelled_at string订单取消时间(结束)(格式见IOS8601),2012-05-01T14:22:25-04:00cart_token string购物车tokencheckout_id string弃单idcheckout_token string结算页tokenclient_detailsobject
客户端详细信息browser_ip string详细地址1session_hash stringsessionIduser_agent string客户端代理created_at string订单创建时间(格式见IOS8601)currency string交易币种current_subtotal_price string当前商品总和,商品总价*数量current_subtotal_price_setobject
当前商品总和多币种信息, 买卖家币种和金额一致presentment_moneyobject
买家侧币种amount string金额currency_code string币种shop_moneyobject
卖家侧金额amount string金额,精度2currency_code string币种codecurrent_total_discounts string折扣总和,精度2,营销优惠+人工折扣current_total_discounts_setobject
presentment_moneyobject
买家侧金额amount string金额currency_code string币种信息shop_moneyobject
卖家侧金额amount string金额currency_code string币种current_total_price string税费总和,商品税 + 运费税current_total_price_setobject
税费总和多币种信息, 买卖家币种和金额一致presentment_moneyobject
买家侧币种amount string金额currency_code string币种shop_moneyobject
卖家侧币种amount string金额currency_code string币种current_total_tax string税费总和,商品税 + 运费税current_total_tax_setobject
税费总和多币种信息, 买卖家币种和金额一致presentment_moneyobject
买家侧币种amount string金额currency_code string币种shop_moneyobject
卖家侧币种amount string金额currency_code string币种customerobject
买家信息addressesobject
买家地址信息address1 string详细地址1address2 string详细地址2,备选city string城市country string国家country_code string国家码first_name string姓last_name string名name string全名phone string电话province string省份province_code string省份码zip string邮编area_code string手机区号created_at string买家创建时间(格式见IOS8601)currency string币种email string用户邮箱first_name string名id string用户idlast_name string姓phone string用户手机号updated_at string买家更新时间customer_locale string买家国家,语种编码+国家名称缩写deduct_member_point_amount string当前订单会员积分抵扣金额discount_applicationsobject[]
折扣信息allocation_method string1)across(该值分布在所有授权行中) 2)each(该值应用于每个授权行)Example:across
code string折扣码Example:1Q3UMQM8RBP5
description string自定义折扣的描述Example:折扣描述
target_selection string1)explicit(折扣分配到明确选择的行) 2)all(折扣分配到所有行) 3)ENTITLED(折扣仅分配到其有权使用的行)Example:explicit
target_type string1)line_item、shipping_lineExample:line_item
title string自动折扣的标题Example:折扣标题
type string折扣类型Example:manual
value string折扣的具体值(可以是 N折,也可以是具体的 金额值)Example:20
value_type string百分比折扣、金额折扣Example:fixed_amount
discount_codesobject[]
优惠码信息amount string优惠金额,精度2code string优惠码type string优惠类型,减金额;打折;免运费;固定售价;最低价商品免费;打包价;第N件打折;email string买家邮箱,二者必有其一financial_status string支付状态,unpaid,authorized, pending,partially_paid,paid,partially_refunded,refundedfulfillment_status string发货状态, fulfilled-已发货; partial-部分发货; null-未发货; 注:返回的枚举值与入参的查询枚举值不一样fulfillmentsobject[]
包裹信息created_at string创建时间(格式见IOS8601)id string包裹编号line_itemsobject[]
商品列表attribute string商品属性:名称 - 属性值 多个以逗号", "分割 如:颜色 - 红色, 尺寸 - Xfulfillable_quantity integer可发货数量fulfillment_service string物流商名称fulfillment_status string商品的发货状态, 发货状态, fulfilled-已发货; partial-部分发货; null-未发货;grams double重量(克)id string商品快照表的id, 系统生成,与订单号唯一确认一个商品name stringsku标题,同titleprice string商品售价,精度2product_id stringspu序列号quantity integer订单中的商品数量requires_shipping boolean是否需要发货sku string商品码,barCodetax_linesobject[]
税费信息price string税费,精度2price_setobject
税费多币种信息presentment_moneyobject
买家侧金额amount string金额currency_code string币种shop_moneyobject
卖家侧金额信息amount string金额currency_code string币种rate double税率title string税费名称taxable boolean是否收税title string商品标题variant_id string商品sku序列号variant_title string商品属性值, 多个以" / "分割, 如: “155 / 红色 / 大"vendor string供应商name string发货单短号Example:1032-F2
order_id string订单号shipment_status string包裹状态status string物流配送状态, success-已发货; cancelled-已取消;tracking_company string物流公司名称tracking_number string第三方物流单号tracking_url string物流公司urlupdated_at string更新时间(格式见IOS8601)id string是否是归档订单, true=已归档订单, false=未归档订单line_itemsobject[]
订单商品快照信息attribute string商品属性:名称 - 属性值 多个以逗号", "分割 如:颜色 - 红色, 尺寸 - Xdiscount_allocationsobject[]
营销折扣明细金额多币种amount string折扣明细金额Example:8.00
amount_setobject
折扣明细金额多币种presentment_moneyobject
支付币种amount string金额,精度2Example:8.00
currency_code string币种Example:USD
shop_moneyobject
店铺币种amount string金额,精度2Example:8.00
currency_code string币种Example:USD
discount_application_index integer标明在折扣明细中的位置Example:1
fulfillable_quantity integer可发货数量fulfillment_service string物流商名称fulfillment_status string商品的发货状态, 发货状态, fulfilled-已发货; partial-部分发货; null-未发货;grams double重量(克)id string商品快照表的id, 系统生成,与订单号唯一确认一个商品location_id stringpos场景下店铺对应的地点Example:5327026538935748524
name stringsku标题,同titleprice string商品售价,精度2product_id stringspu序列号propertiesobject[]
商品定制信息additional string定制商品附加字段name string自定义属性名称type string属性类型, text-字符,展示格式为 name: value; picture-图片,展示类型为 name: 通过urls获取渲染出缩略图;link-超链,展示类型为 name: value,支持点击链接跳转 到urls第一个urls arrayurl资源列表Example: ``value string自定义属性值quantity integer订单中的商品数量requires_shipping boolean是否需要发货sku string商品码,barCodetags string商品标签(多个逗号隔开)tax_linesobject[]
税费信息price string税费,精度2price_setobject
税费多币种信息presentment_moneyobject
买家侧币种amount string金额currency_code string币种shop_moneyobject
卖家侧币种amount string金额currency_code string币种rate double税率title string税费名称type string税费用类型,用于区分是商品税还是运费税,枚举值如下 product_tax:商品税 shipping_tax:运费税Example:shipping_tax
taxable boolean是否收税title string商品标题variant_id string商品sku序列号variant_title string商品属性值, 多个以" / "分割, 如: “155 / 红色 / 大"vendor string供应商name string自定义订单号note string商家备注内容note_attributesobject[]
商家备注日志,日期内容create_time string备注创建时间(格式见IOS8601)name string备注来源(卖家标识)value string备注内容order_status_url string订单状态页urlpayment_detailsobject[]
支付单信息create_time string支付单创建时间order_seq string订单号pay_amount double支付金额pay_channel_deal_id string外部渠道支付流水号pay_seq string支付单号pay_status string支付单状态, unpaid-未支付;pending-支付中;risking-风控中;paid-已支付;paid_overtime-支付失败;paid_failed-支付失败;payment_gateway_names array付款方式列表,该订单所用到的付款方式列表, SLpayments ,Paypal(PayPal支付), Oceanpay(钱海支付), TwoCheckout,AsiaBill, Stripe,Pacypay, WorldPay, COD(货到付款), CUSTOM(自定义), adjustPay(资金调整), Xendit(xendit信用卡), XenditOtherExample: ``phone string买家联系方式,二者必有其一presentment_currency string买家侧币种,同卖家侧币种processed_user_id string订单创建者refundsobject[]
退款列表created_at string退款单创建时间 (格式见IOS8601)id string退款idnote string退款备注order_id string订单号processed_at string更新时间 (格式见IOS8601)refund_line_itemsobject[]
退款详细信息id string退款单号line_itemobject
退款商品行attribute string商品属性:名称 - 属性值 多个以逗号", "分割 如:颜色 - 红色, 尺寸 - Xfulfillable_quantity integer可发货数量fulfillment_service string物流商名称fulfillment_status string商品的发货状态, 发货状态, fulfilled-已发货; partial-部分发货; null-未发货;grams double重量(克)id string商品快照表的id, 系统生成,与订单号唯一确认一个商品name stringsku标题,同titleprice string商品售价,精度2product_id stringspu序列号quantity integer订单中的商品数量requires_shipping boolean是否需要发货sku string商品码,barCodetax_linesobject[]
税费信息price string税费,精度2price_setobject
税费多币种信息presentment_moneyobject
买家侧币种amount string金额,精度2currency_code string币种shop_moneyobject
卖家侧金额信息amount string金额currency_code string币种rate double税率title string标题taxable boolean是否收税title string商品标题variant_id string商品sku序列号variant_title string商品属性值, 多个以" / "分割, 如: “155 / 红色 / 大"vendor string供应商line_item_id string商品快照表的id, 系统生成,与订单号唯一确认一个商品quantity integer数量,商品数量restock_type string库存返还类型,no_restock-未返还,cancel-取消, return-返还 只有未返还subtotal double退款金额合计,精度2subtotal_setobject
退款金额合计,多币种信息,卖家和买家侧相同presentment_moneyobject
买家侧币种amount string金额currency_code string币种shop_moneyobject
卖家侧金额信息amount string金额,精度2currency_code string币种total_tax double退款商品的税额,精度2total_tax_setobject
总税额,多币种信息presentment_moneyobject
买家侧币种amount string金额currency_code string币种shop_moneyobject
卖家侧币种amount string金额currency_code string币种transactionsobject[]
退款交易信息amount string退款金额,精度2created_at string创建时间currency string币种id string退款idkind string交易类型(authorization, capture, sale, void, refund)order_id string订单号processed_at string创建时间status string处理状态, pending, failure, success, and erroruser_id string买家iduser_id string用户idshipping_addressobject
收货地址address1 string地址1address2 string详细地址2,备选city string城市company string公司名称country string国家country_code string国家码first_name string姓last_name string名latitude string纬度longitude string经度name string全名phone string电话province string省份province_code string省份码zip string邮编shipping_linesobject[]
物流信息code string物流编号discount_allocationsobject[]
折扣明细amount string折扣金额,精度2Example:8.00
amount_setobject
折扣多币种金额presentment_moneyobject
买家侧金额信息amount string金额,精度2Example:8.00
currency_code string币种Example:USD
shop_moneyobject
店铺侧金额信息amount string金额,精度2Example:8.00
currency_code string币种Example:USD
discount_application_index integer折扣索引信息:标明在折扣明细中的位置Example:1
discounted_price string折扣金额,精度2discounted_price_setobject
折扣多币种金额presentment_moneyobject
买家侧金额信息amount string金额,精度2Example:8.00
currency_code string币种Example:USD
shop_moneyobject
店铺侧金额信息amount string金额,精度2Example:8.00
currency_code string币种Example:USD
phone string电话price string物流运费,精度2price_setobject
物流运费多资源信息presentment_moneyobject
买家侧金额信息amount string金额,精度2Example:8.00
currency_code string币种Example:USD
shop_moneyobject
店铺侧金额信息amount string金额,精度2Example:8.00
currency_code string币种Example:USD
requested_fulfillment_service_id string运输服务代号Example:LX88888
shipping_price string原运费金额值(非折扣后金额)Example:8.00
source string运费来源tax_linesobject[]
物流征税列表price string税费price_setobject
税费多币种信息presentment_moneyobject
买家侧金额信息amount string金额currency_code string币种shop_moneyobject
卖家侧金额信息amount string金额,精度2currency_code string币种rate double税率title string税费名称title string物流名称store_id string店铺idsubtotal_price string商品折后价总和, 商品总价 - 营销优惠 - 人工折扣subtotal_price_setobject
商品折后价总和多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2currency_code string币种shop_moneyobject
卖家侧金额信息amount string金额,精度2currency_code string币种tags string订单标签,无tax_linesobject[]
税费信息price string税费名称price_setobject
税费多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2currency_code string币种shop_moneyobject
卖家侧金额信息amount string金额,精度2currency_code string币种rate double税率title string税费名称tax_number string税号tax_type string税号类型taxes_included boolean总计额是否包含税额total_discounts string折扣总额,营销优惠+人工折扣total_discounts_setobject
折扣总额多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2currency_code string币种shop_moneyobject
卖家侧金额信息amount string金额,精度2currency_code string币种total_line_items_price string商品原价总和,精度2total_line_items_price_setobject
商品原价总和,多币种信息presentment_moneyobject
卖家侧金额信息amount string金额,精度2currency_code string币种shop_moneyobject
卖家侧金额信息amount string金额,精度2currency_code string币种total_outstanding string未付款金额总和,精度2total_shipping_price_setobject
订单运费总和,多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2currency_code string币种shop_moneyobject
卖家侧金额信息amount string金额,精度2currency_code string币种total_tax string税费总和,精度2, 商品税 + 运费税total_tax_setobject
税费总和,多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2currency_code string币种shop_moneyobject
卖家侧金额信息amount string金额,精度2currency_code string币种total_tip_received string小费,精度2total_weight double商品总重量(g)updated_at string订单更新时间,(格式见IOS8601)user_id string买家id
API Explorer
调试台
这篇文章对你有帮助吗?
Error loading component.