更新订单
PUT https://{handle}.myshopline.com/admin/openapi/v20260301/orders/:id.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handle 是 open001 。指定订单更新信息。如果字段传空值或不传,则不更新该字段信息。
路径参数
- id string required订单 ID。
请求头
- Content-Type string required字段值固定为
application/json; charset=utf-8。 - Authorization string required资源的访问令牌。参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。例子:
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
请求体
orderobject
订单信息。area_code string买家国家或地区的手机区号。customer_id string买家 ID。email string买家的邮箱地址。id string订单号。line_itemsobject[]
需要更新标签的商品。id string商品快照表的 ID,系统生成,与订单 ID 唯一确认一个商品。tags string商品标签,多个以英文逗号分割,会覆盖现有标签。note_attributesobject[]
商家备注日志。name string卖家标识,表明备注来源。value string备注内容。phone string买家的手机号码。shipping_addressobject
收货地址。address1 string地址的第一行。通常是街道地址或邮政信箱编号等信息。address2 string地址的第二行。通常是公寓、套房或单元等信息。area string地址中的区县名称。area_code string地址中的区县编码。city string地址中的城市。city_code string地址中的城市编码。company string收件人所在的公司名称。 最大长度限制:64country string地址中的国家或区域。 最大长度限制:64email string收件人的邮箱。first_name string收件人的名。last_name string收件人的姓。 最大长度限制:64latitude string地址所在的纬度。longitude string地址所在的经度。phone string收件人的手机号。province string地址中的省份。province_code string地址中省份或区域的编码,该编码为系统自动生成。zip string地址的邮编信息。tags string商品标签,多个以逗号隔开。
状态码
- 200
- 400
- 401
- 429
更多状态码信息,参考 HTTP 状态码。
响应头
traceId
请求的全局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。
响应体
orderobject
订单信息。app_id string应用方 ID。billing_addressobject
用于邮寄账单发票的地址。address1 string账单地址的第一行。通常是街道地址或邮政信箱编号等信息。address2 string账单地址的第二行。通常是公寓、套房或单元等信息。city string账单地址中的城市。company string账单收件人所在的公司名称。country string账单地址中的国家或区域。first_name string账单收件人的名。last_name string账单收件人的姓。name string账单收件人的全名。phone string账单收件人的手机号。province string账单地址中的省份。province_code string地址中省份或区域的编码,该编码为系统自动生成。standard_province_code stringzip string账单地址的邮编信息。browser_ip string买家下单时的浏览器 IP 地址。cancel_reason string卖家取消原因。cart_token string购物车数据的唯一标识。checkout_id string弃单 ID。checkout_token string弃单数据的唯一标识,C 端用户发起结算,会生成弃单 。client_detailsobject
客户端详细信息。browser_ip string买家下单时的浏览器 IP 地址。session_hash string会员会话加密信息。user_agent string客户端代理。companyobject
买家下单时买家所在的公司信息。id string公司 ID。location_id string地点 ID。tax_registration_id string税号信息。credit_limitobject
信用支付信息。credit_limit_currency string信用额度币种,与店铺币种相同。三位币种码,遵循 ISO 4217 国际标准。is_credit_limit boolean订单是否使用了信用支付。true:有使用false:未使用
outstanding_credit_limit string占用的信用额度总和。初始和total_credit_limit相等,如果后续有类似还款操作,占用的额度则相应减少。total_credit_limit string使用的信用额度总和,即该笔订单用了多少信用额度支付。current_subtotal_price string商品金额总和,为商品单价 * 数量,以店铺币种展示。current_total_discounts string折扣金额总和,数值保留到小数点后两位,为营销优惠 + 人工折扣,以店铺币种展示。current_total_discounts_setobject
折扣金额总和,数值保留到小数点后两位,为营销优惠 + 人工折扣,分别以买家币种金额和店铺币种金额展示。current_total_price string订单总额,以店铺币种金额展示。current_total_tax string税费金额总和,以店铺币种金额展示customerobject
买家信息。addressesobject
买家地址信息。address1 string买家地址的第一行。通常是街道地址或邮政信箱编号等信息。address2 string买家地址的第二行。通常是公寓、套房或单元等信息。city string买家地址中的城市。country string买家地址中的国家或区域。first_name string买家地址中收件人的名。last_name string买家地址中收件人的姓。name string买家的姓名。phone string买家的手机号码。province string买家地址中的省份。province_code string地址中省份或区域的编码,该编码为系统自动生成。zip string买家地址的邮编信息。area_code string国家或地区的手机区号。currency string三位币种码,遵循 ISO 4217 国际标准。email string买家的邮箱地址。first_name string买家的名。id string买家 ID。last_name string买家的姓。phone string买家的手机号。customer_locale string买家语种编码 + 国家或地区码。语种编码遵循 ISO 639 标准。国家或地区码遵循 ISO 3166-1 标准。无法获取到语言信息时,仅返回国家或地区代码。deduct_member_point_amount string当前订单会员积分抵扣金额,以店铺币种展示。数值保留到小数点后两位。deduct_member_point_amount_setobject
当前订单会员积分抵扣金额,分别以买家币种金额和店铺币种金额展示。discount_applicationsobject[]
折扣信息。allocation_method string折扣的范围。有效枚举值包括:across: 按照购买总数折扣each: 按照单个商品分别折扣
示例:如一次购买三个相同的商品,折扣为 10 元。如果allocation_method为across代表三个一起减 10 元;如果allocation_method为each代表每个减 10 元。code string折扣码。description string自定义折扣的描述。target_selection string折扣范围。有效枚举值包括:explicit:单个商品维度的折扣entitled:整个商品行维度的折扣all:若target_type为line_item,折扣适用于整单;若target_type为shipping_line, 折扣适用于运费
target_type string折扣应用的对象。有效枚举值包含:line_item:作用在商品上的折扣shipping_line:作用在运费上的折扣
title string自动折扣的标题。type string折扣类型。有效枚举值包含:manual:手动折扣automatic:自动折扣discount_code:折扣码
value string折扣的具体值,以店铺币种展示。- 当
value_type为fix_amount时,此字段值表示特定的折扣金额。例如,如果值为10,商店币种为人民币,则表示折扣为 10 元。 - 当
value_type为percentage时,此字段值的值表示特定的折扣百分比。例如,10表示订单金额的 10% 折扣。
value_type string折扣值的类型。有效枚举值包含:fix_amount:固定金额折扣。例如,如果value为10,则意味着折扣为 10 元。percentage:百分比折扣。例如,如果value为10,则表示订单金额的 10% 折扣。
discount_codesobject[]
优惠码信息列表。amount string优惠金额,以店铺币种展示,数值保留到小数点后两位。code string优惠码。type string优惠类型。有效枚举值包含:减金额:全场满 100 元立减 10 元打折:全场满 100 元打 9 折免运费:满 3 件免运费加价品:需要支付额外金额任意N件优惠价:任意买 3 件商品,只需 99 元A+B组合优惠价:同时买 A 商品和 B 商品,两件一起只需 88 元赠品:购买制定商品赠送额外商品固定售价:统一售价 29 元最低价商品免费:买 3 件商品,最便宜的那件免费打包价:多件商品组合以固定总价出售第N件打折:第 2 件打 8 折买x送y:满 2 件送 1 件自定义:自定义折扣
废弃:返回的值为中文。 该字段自 API 版本 v20250601 起已废弃。email string买家邮箱。financial_status string订单付款状态。有效枚举值包含:unpaid:未支付authorized:已授权pending:处理中partially_paid:部分付款paid:已付款partially_refunded:部分退款refunded:已退款
fulfillment_status string发货状态。有效枚举值包含:fulfilled:已发货partial:部分发货null:未发货
fulfillmentsobject[]
发货单信息列表。id string发货单 ID。line_itemsobject[]
商品列表。attribute string款式规格信息,以款式名称和规格值拼接展示。例子:color - redfulfillable_quantity integer商品剩余可发货数量。fulfillment_service string物流商名称。fulfillment_status string商品发货状态。有效枚举值包含:fulfilled:已发货partial:部分发货null:未发货
grams double重量,单位:g。id string商品快照表的 ID,系统生成,与订单 ID 唯一确认一个商品。name stringSKU 标题,该字段值和title一致。price string商品售价,以店铺币种展示。数值保留到小数点后两位。product_id string款式对应商品的唯一标识 ID。quantity integer订单中的商品数量。requires_shipping boolean商品是否需要发货。true:需要发货false:不需要发货
sku string商品 SKU。tax_linesobject[]
税费明细列表。price string税费,以店铺币种展示。数值保留到小数点后两位。rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。taxable boolean该商品是否需要收税。true:需要收税false:不需要收税
title string商品标题。variant_id string款式的唯一标识 ID。variant_title string商品款式值,多个以/分割。vendor string供应商。name string发货单编码。order_id string订单号。shipment_status string发货单物流状态。有效枚举值包含:out_for_delivery:正在配送delivered:已送达faliure:配送失败picked_up:已取货
status string发货单状态。有效枚举值包含:success:已发货cancelled:已取消
tracking_company string废弃:物流公司名称。该字段自 API 版本 v20250601 起已废弃。查看tracking_info_list字段。tracking_info_listobject[]
物流追踪信息列表。tracking_company string物流服务商。tracking_number string物流单号。tracking_url string物流公司的域名。tracking_number string第三方物流单号。废弃:该字段自 API 版本 v20250601 起已废弃。查看tracking_info_list字段。tracking_url string物流公司的域名。废弃:该字段自 API 版本 v20250601 起已废弃。查看tracking_info_list字段。id string订单号,系统自定义编号。line_itemsobject[]
订单商品快照信息列表。attribute string款式规格信息,以款式名称和规格值拼接展示。例子:color - redcountry_code_of_origin string原产地或发货地的国家或地区代码。遵循 ISO 3166-1 国际标准。discount_allocationsobject[]
营销折扣金额,分别以买家币种金额和店铺币种金额展示。amount string营销折扣金额,数值保留到小数点后两位。discount_application_index integer标明商品行应用的折扣在orders.discount_applications中的位置。dutiesobject[]
关税信息。harmonized_system_code string海关编码,用于在国际贸易中对产品进行分类。id string关税编号。tax_linesobject[]
税费信息列表。rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。rate_percentage double税率,以百分比数值形式表示,数值保留到小数点后两位。如果税率为2%,该值为2.00。该信息只做展示作用。title string税费标题,该信息只做展示作用。fulfillable_quantity integer剩余可发货数量。fulfillment_service string物流商名称。fulfillment_status string商品发货状态。有效枚举值包含:fulfilled:已发货partial:部分发货null:未发货
grams double重量,单位:g。harmonized_system_code string海关编码,用于在国际贸易中对产品进行分类。id string商品快照表的 ID,系统生成,与订单 ID 唯一确认一个商品。location_id string本地配送地点编号或普通配送地点编号。name stringSKU 标题,该字段值和title一致。price string商品售价,以店铺币种金额展示,数值保留到小数点后两位。product_id string款式对应商品的唯一标识 ID。propertiesobject[]
商品定制信息列表。additional string定制商品附加字段,比如当name为文字,additional可以附加文字的字号、字体、颜色等。name string自定义属性名称。type string定制信息类型。有效枚举值包含:text:字符类型picture:图片类型link:链接类型
urls arrayURL 列表。如果type是picture,可通过urls获取缩略图,如果type是link,那么超链接为urls的第一个。value string自定义属性值。quantity integer订单中的商品数量。requires_shipping boolean商品是否需要发货。true:需要发货false:不需要发货
sku string商品 SKU。tags string商品标签,多个以逗号隔开。tax_linesobject[]
税费明细列表。price string税费,以店铺币种展示。数值保留到小数点后两位。rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。type string税费类型。有效枚举值包含:product_tax: 商品税shipping_tax: 运费税
taxable boolean该商品是否需要收税。true:需要收税false:不需要收税
title string商品标题。variant_id string款式的唯一标识 ID。variant_title string商品属性值,多个以/分割。vendor string供应商。locationsobject[]
到店取货地点地址信息列表。location_id string取货地点唯一编号。name string取货地址名称。type string地点类型。有效枚举值包含:posLocation:POS 渠道创建该订单的门店地点(建议使用pos_location_id,后续将废弃)。pickupLocation:当订单的配送方式为自提时,自提的门店地点。productLocation:订单中商品的库存地点(建议使用商品行中的location_id信息,后续将废弃)。
name string商家自定义的订单号,从 1001 开始,可以设置前缀。note string商家备注内容。note_attributesobject[]
商家备注日志。name string卖家标识,表明备注来源。value string备注内容。order_source string订单来源渠道,目前只有 POS 渠道该字段才有值,其他渠道该值为空。order_status_url string订单状态页 URL。payment_detailsobject[]
支付单信息列表。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:支付失败
status_code string支付网关标准状态码。status_msg string支付网关状态码信息。payment_gateway_names array付款方式列表。有效枚举值包含:SLpaymentsPaypal(PayPal支付)Oceanpay(钱海支付)TwoCheckoutAsiaBillStripePacypayWorldPayCOD(货到付款)CUSTOM(自定义)adjustPay(资金调整)Xendit(xendit 信用卡)XenditOther
phone string买家的手机号。po_number stringB2B 场景在订单上记录的采购订单号。pos_location_id stringPOS 交易地点 ID。processed_user_id string订单创建者的 ID。refundsobject[]
退款列表。id string退款 ID。note string卖家退款备注。order_id string订单号。refund_line_itemsobject[]
商品行退款详情列表。id string退款单号。line_itemobject
发货单商品行信息。attribute string款式规格信息,以规格名称和规格值拼接展示。例子:color - redfulfillable_quantity integer剩余可发货数量。fulfillment_service string物流商名称。fulfillment_status string商品发货状态。有效枚举值包含:fulfilled:已发货partial:部分发货null:未发货
grams double重量,单位:g。id string商品快照表的 ID,系统生成,与订单 ID 唯一确认一个商品。name stringSKU 标题,该字段值和title一致。price string商品售价,以店铺币种展示。数值保留到小数点后两位。price_setobject
商品售价,分别以店铺币种金额和买家币种金额展示。product_id string款式对应商品的唯一标识 ID。quantity integer订单中的商品数量。requires_shipping boolean商品是否需要发货。true:需要发货false:不需要发货
sku string商品 SKU。tax_linesobject[]
税费明细列表。price string税费,以店铺币种展示。数值保留到小数点后两位。rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。taxable boolean该商品是否需要收税。true:需要收税false:不需要收税
title string商品标题。variant_id string款式的唯一标识 ID。variant_title string商品属性值,多个以/分割。vendor string供应商。line_item_id string商品快照表的 ID,系统生成,与订单 ID 唯一确认一个商品。quantity integer退款商品数量。restock_type string库存返还类型。有效枚举值包含:no_restock:未返还cancel:取消return:返还
subtotal double退款金额合计,以店铺币种金额展示。数值保留到小数点后两位。total_tax double退款商品的税额,以店铺币种展示。数值保留到小数点后两位。transactionsobject[]
退款交易信息列表。amount string退款金额,数值保留到小数点后两位。id string退款 ID。kind string交易类型, 返回值为refund。order_id string订单号。status string处理状态。有效枚举值包含:pending:退款中failure:退款失败success:退款成功error:退款出 错
user_id string买家 ID。user_id string买家 ID。shipping_addressobject
收货地址。address1 string地址的第一行。通常是街道地址或邮政信箱编号等信息。address2 string地址 的第二行。通常是公寓、套房或单元等信息。city string地址中的城市。company string收件人所在的公司名称。country string地址中的国家或区域。country_code string地址中国家或区域的二位码,遵循 ISO 3166-1 国际标准的二位国家或区域码。first_name string收件人的名。last_name string收件人的姓。latitude string地址所在的纬度。longitude string地址所在的经度。name string买家的全名。phone string收件人的手机号码。province string收货地址中州或省的名称。province_code string地址中省份或区域的编码,该编码为系统自动生成。standard_province_code stringzip string地址的邮编信息。shipping_linesobject[]
运费列表。code string只有本地配送运费方案有值,返回Local delivery。discount_allocationsobject[]
营销折扣金额,分别以买家币种金额和店铺币种金额展示。amount string折扣金额,以店铺币种展示。数值保留到小数点后两位。discount_application_index integer标明商品行应用的折扣在orders.discount_applications中的位置。discounted_price string折扣金额,以店铺币种展示。数值保留到小数点后两位。phone string买家的手机号。price string运费,以店铺币种展示。数值保留到小数点后两位。requested_fulfillment_service_id string运输服务代号。shipping_price string原运费金额值,非折扣后金额,以店铺币种展示。数值保留到小数点后两位。source string物流承运商类型。有效枚举值包含:Shipper:Shipper 物流Oneship:Oneship 物流Api:通过开放能力添加的承运商的物流null:系统物流或自定义物流
tax_linesobject[]
税费信息列表。price string税费,以店铺币种展示。数值保留到小数点后两位。rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费名称。title string物流公司名称。store_id string店铺 ID。subtotal_price string商品折后价总和,数值保留到小数点后两位,为商品总价 - 营销优惠 - 自定义折扣,以店铺币种展示。tags string订单标签。tax_linesobject[]
税费信息列表。price string税费,以店铺币种展示。数值保留到小数点后两位。rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。tax_number string税号。tax_type string订单的税费类型。有效枚举值包含:product_tax:商品税shipping_tax:运费税
taxes_included boolean该订单是否包含税费金额。true:包含税费金额false:不包含税费金额
total_discounts string订单折扣总和,为营销折扣 + 自定义折扣,数值保留到小数点后两位,以店铺币种金额展示。废弃:该字段自 API 版本 v20210901 起已废弃。例子:3.25total_discounts_setobject
订单折扣总和,为营销折扣 + 自定义折扣,分别以店铺币种金额和买家币种金额展示。废弃:该字段自 API 版本 v20210901 起已废弃。total_line_items_price string商品原价总和,数值保留到小数点后两位,以店铺币种金额展示。total_outstanding string未付款金额总额,数值保留到小数点后两位,以店铺币种金额展示。total_tax string税费总额,数值保留到小数点后两位,以店铺币种金额展示。total_tip_received string小费,数值保留到小数点后两位,以店铺币种金额展示。total_weight double商品总重量,单位:g。user_id string买家 ID。
API Explorer
调试台
示例代码
这篇文章对你有帮助吗?