创建订单
POST https://{handle}.myshopline.com/admin/openapi/v20260301/orders.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handle 是 open001 。创建订单。
请求头
- Content-Type string required字段值固定为
application/json; charset=utf-8。 - Authorization string required资源的访问令牌。参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。例子:
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
请求体
orderobject required
订单信息。billing_addressobject
用于邮寄账单发票的地址。address1 string账单地址的第一行。通常是街道地址或邮政信箱编号等信息。最大长度限制:256例子:Xiaoguwei Streetaddress2 string账单地址的第二行。通常是公寓、套房或单元等信息。最大长度限制:256例子:Apartment 5area string账单地址中的区或县。最大长度限 制:64例子:Panyu Districtarea_code string账单地址中区或县的编码。例子:510007city string账单地址中的城市。最大长度限制:64例子:Guangzhou Citycity_code string账单地址中城市的编码。例子:510000company string账单收件人的公司名称。例子:Company Namecountry string账单地址中的国家或地区。最大长度限制:64例子:Chinaemail string账单收件人的邮箱。例子:test001@Gmail.comfirst_name string账单收件人的名。例子:Tomlast_name string账单收件人的姓。例子:Washingtonphone string账单收件人的手机号码。例子:13903004000province string账单地址中的省份。例子:Guangdong Provincesame_as_receiver boolean表示账单地址billing_address是否与收货地址shipping_address是一样的。zip string账单地址的邮编信息。例子:510036buyer_note string买家留言。例子:messagecompany_location_id string公司地点 ID,用于创建 B2B 订单。例子:3232423438438customerobject
买家信息。area_code string国家或地区的手机区号。例子:+86email string买家的邮箱地址。例子:test001@Gmail.comfirst_name string买家的名。例子:Tomid string买家 ID。最大长度限制:64例子:4201057495last_name string买家的姓。例子:Washingtonphone string买家手机号。例子:13903004000exchange_rate string订单货币和店铺货币之间的汇率。例子:7.1245financial_status string订单的付款状态。有效枚举值包含:unpaid:未支付partially_paid:部分支付paid:已完成支付
默认值:unpaid注意:传入枚举值的准确性会进行强校验,如果枚举值校验不通过,则订单创建会失败,会报错financial_status is invalid。fulfillment_status string订单的发货状态。有效枚举值包含:unshipped:未发货shipped:已发货
默认值:unshipped注意:传入枚举值的准确性会进行强校验,如果枚举值校验不通过,则订单会创建失败,会报错fulfillment_status is invalid。inventory_behaviour string在订单创建过程中库存的处理方式。有效枚举值包含:bypass:不处理库存。在创建订单时,系统不会对库存进行任何操作,库存数量不会发生变化。decrement_ignoring_policy:扣减库存。不受商家配置的库存策略影响。decrement_obeying_policy:按照商家配置的库存策略扣减库存。
line_itemsobject[] required
订单商品快照信息列表。discount_priceobject
商品自定义折扣明细。amount string折扣金额。数值保留到小数点后两位。例子:1.00title string折扣名称。例子:Discount namelocation_id string商品库存地点 ID。例子:5445886274929439997price string商品售价,数值保留到小数点后两位。例子:3.25product_id string款式对应商品的唯一标识 ID。例子:16056761559984840457934011propertiesobject[]
商品定制信息列表。name string自定义属性名称例子:attribute nameshow boolean定制信息是否可见:true:可见false:不可见 默认值:false
type string定制信息类型。有效枚举值包含:text:字符类型picture:图片类型link:链接类型
urls arrayURL 资源列表。- 如果
type是picture,可通过urls获取渲染出缩略图。 - 如果
type是link,那么超链接为urls的第一个。
例子:["[\"https://www.url.com\"]"]value string自定义属性值例子:attribute valuequantity long商品数量。例子:1requires_shipping boolean表明商品是否需要运输。true:需要运输false:不需要运输
shipping_line_title string商品行匹配的运费方案标题。在传入shipping_lines情况下,当前字段必传。tax_lineobject
自定义商品税费信息。price string税费金额。商品实际收税以此字段金额为准,传入的rate税费仅做展示作用。例子:3.25rate string税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。例子:Tax nametaxable boolean该商品是否需要收税。true:需要收税false:不需要收税
默认值:truetitle string商品标题。例子:beautiful skirtvariant_id string分配给库存中某一特定商品的唯一编码。例子:18056761559987524812644011name string订单编号(和订单 ID 不同,该编号可以在商家后台自定义前缀)。例子:D101note string订单备注。最大长度限制:50废弃:该字段自 API 版本 v20210901 起已废弃。例子:Notesnote_attributesobject[]
商家备注日志列表。name string商家 ID,表明备注来源。例子:Note sourcevalue string备注内容。例子:Notesorder_note string商家订单备注。最大长度限制:50例子:Notesprice_infoobject required
价格信息。current_extra_total_discounts string订单折扣金额,不包含折扣码优惠。数值保留到小数点后两位。例子:8.00taxes_included boolean该订单是否包含税费金额。true:包含税费金额false:不包含税费金额
total_shipping_price string运费,以店铺币种展示。数值保留到小数点后两位。例子:8.00send_fulfillment_receipt boolean是否发送订单发货邮件。true: 发送false:不发送
send_receipt boolean是否发送订单确认邮件。true: 发送false:不发送
shipping_addressobject
收货地址信息。address1 string收货地址的第一行。通常是街道地址或邮政信箱编号等信息。最大长度限制:255例子:Xiaoguwei Streetaddress2 string收货地址的第二行。通常是公寓、套房或单元等信息。最大长度限制:255例子:Apartment 5area string收货地址中的区或县。最大长度限制:64例子:Panyu Districtarea_code string收货地址中区或县的编码。例子:510006city string收货地址中的城市。最大长度限制:64例子:Guangzhou Citycity_code string收货地址中城市的编码。例子:510000company string收件人的公司名称。例子:Company Namecountry string收货地址中的国家或区域。最大长度限制:64例子:Chinaemail string买家的邮箱地址。例子:test001@Gmail.comfirst_name string收件人的名。最大长度限制:64例子:Tomlast_name string收件人的姓。最大长度限制:64例子:Washingtonlatitude string收货地址所在的纬度。例子:43longitude string收货地址所在的经度。例子:34phone string收件人的手机号码。例子:13903004000province string收货地址中的州或省份。例子:Guangdong Provincezip string收货地址的邮编信息。例子:510036shipping_lineobject
运费信息。code string物流编号。例子:SFprice string运费金额,数值保留到小数点后两位。例子:3.25tax_lineobject
自定义商品税费信息。price string税费金额。商品实际收税以此字段金额为准,传入的rate税费仅做展示作用。例子:100rate string税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。例子:Tax nametitle string运费名称。例子:Shipping nameshipping_linesobject[]
运费方案列表。 最大个数限制 :10price string运费金额tax_lineobject
运费税费明细price string税费金额rate string税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。title string运费名称。transaction_listobject[]
支付单列表。amount string支付单金额。数值保留到小数点后两位。例子:3.25gateways string支付渠道。例子:PayPalstatus string required支付状态。有效枚举值包含:unpaid: 未支付failure:支付失败success:支付成功error:支付出错
例子:stringtransactionsobject
支付单信息。id string支付方式 ID。例子:424243
状态码
- 200
- 401
- 429
更多状态码信息,参考 HTTP 状态码。
响应头
traceId
请求的全局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。
响应体
orderobject
订单信息。adjust_price stringPOS 交易场景下因金额四舍五入带来的差额金额,用店铺币种。例子:7.23adjust_price_setobject
POS 交易场景下因金额四舍五入带来的差额金额,分别以买家币种和卖家币种展示。billing_addressobject
用于邮寄账单发票的地址。address1 string账单地址的第一行。通常是街道地址或邮政信箱编号等信息。例子:Xiaoguwei Street,address2 string账单地址的第二行。通常是公寓、套房或单元等信息。例子:Apartment 5city string账单地址中的城市。例子:Guangzhou Citycompany string账单收件人所在的公司名称。例子:new companycountry string账单地址中的国家或区域。例子:Chinafirst_name string账单收件人的名。例子:Tomlast_name string账单收件人的姓。例子:Washingtonphone string账单收件人的手机号码。例子:13100000000province string账单地址中的省份。例子:Guangdong Provincestandard_province_code string账单地址中省份的编码,该编码为二位的 ISO 3166-2 国际编码,区别于province_code返参为自定义编码。zip string账单地址的邮编信息。例子:510000current_subtotal_price string商品金额总和,为商品单价 * 数量,以店铺币种展示。例子:7.12current_subtotal_price_setobject
商品金额总和,为商品单价 * 数量,分别以买家币种和店铺币种展示。current_total_discounts string折扣金额总和,数值保留到小数点后两位,为营销优惠 + 人工折扣,以店铺币种展示。例子:0.25current_total_discounts_setobject
折扣金额总和,数值保留到小数点后两位,为营销 优惠 + 人工折扣,分别以买家币种金额和店铺币种金额展示。current_total_duties_setobject
商品总关税,分别以买家币种金额和店铺币种金额展示。current_total_price string订单总额,以店铺币种金额展示。例子:1000.25current_total_price_setobject
订单总额,分别以买家币种金额和店铺币种金额展示。current_total_tax string税费金额总和,以店铺币种金额展示。例子:2.41customerobject
买家信息。area_code string国家或地区的手机区号。例子:+86email string买家的邮箱地址。例子:test001@Gmail.comfirst_name string买家的名。例子:Tomid string买家 ID。例子:4201057495last_name string买家的姓。例子:Washingtonphone string买家的手机号。例子:13100000000deduct_member_point_amount string当前订单会员积分抵扣金额,以店铺币种展示。数值保留到小数点后两位。例子:3.25deduct_member_point_amount_setobject
当前订单会员积分抵扣金额,分别以买家币种金额和店铺币种金额展示。discount_codesobject
优惠码信息。amount string优惠金额,以店铺币种展示,数值保留到小数点后两位。例子:3.25code string优惠码。例子:82UD6BTPX9L2type string优惠类型。有效枚举值包含:减金额:全场满 100 元立减 10 元打折:全场满 100 元打 9 折免运费:满 3 件免运费加价品:需要支付额外金额任意N件优惠价:任意买 3 件商品,只需 99 元A+B组合优惠价:同时买 A 商品和 B 商品,两件一起只需 88 元赠品:购买制定商品赠送额外商品固定售价:统一售价 29 元最低价商品免费:买 3 件商品,最便宜的那件免费打包价:多件商品组合以固定总价出售第N件打折:第 2 件打 8 折买x送y:满 2 件送 1 件自定义:自定义折扣
注意:返回的值为中文。email string买家邮箱。例子:test001@Gmail.comfinancial_status string订单付款状态。有效枚举值包含:unpaid:未支付authorized:已授权pending:处理中partially_paid:部分付款paid:已付款partially_refunded:部分退款refunded:已退款
id string订单号,系统自定义编号。例子:21050224312121887324667162, 21050224312121887324667164line_itemsobject[]
订单商品快照信息列表。attribute string款式规格信息,以款式名称和规格值拼接展示。例子:reddutiesobject[]
关税信息。harmonized_system_code string海关编码,用于在国际贸易中对产品进行分类。例子:D2314244id string关税编号。例子:3155232tax_linesobject[]
税费 信息列表。rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。rate_percentage double税率,以百分比数值形式表示,数值保留到小数点后两位。如果税率为2%,该值为2.00。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。例子:tariffharmonized_system_code string海关编码,用于在国际贸易中对产品进行分类。例子:harmonized system codeid string商品快照表的 ID,系统生成,与订单号order.id唯一确认一个商品。例子:3452image_url string商品图片的 URL 地址。例子:https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969name stringSKU 标题,该字段值和title一致。例子:skirtprice string商品售价,以店铺币种金额展示,数值保留到小数点后两位。例子:100product_id string款式对应商品的唯一标识 ID。例子:16056761559984840457934011propertiesobject[]
商品定制信息列表。name string自定义属性名称。例子:attribute nameshow boolean定制信息是否可见:true:可见false:不可见 默认值:false
type string定制信息类型。有效枚举值包含:text:字符类型picture:图片类型link:链接类型
urls arrayURL 资源列表。- 如果
type是picture,可通过urls获取渲染出缩略图。 - 如果
type是link,那么超链接为urls的第一个。
例子:["[\"https://www.url.com\"]"]value string自定义属性值。例子:attribute valuequantity integer订单中的商品数量。例子:1requires_shipping boolean商品是否需要发货。true:需要发货false:不需要发货
sku string商品 SKU 序列号。例子:18056761559987524812644011tags string商品标签,多个以逗号隔开。例子:watchtax_linesobject[]
税费明细列表。name string税费名称例子:taxesprice string税费,以店铺币种展示。数值保留到小数点后两位。例子:3.25rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。例子:taxestaxable boolean该商品是否需要收税。true:需要收税false:不需要收税
title string商品标题。例子:beautiful skirtvariant_id string分配给库存中某一特定商品的唯一编码。例子:18056761559987524812644011variant_title string商品属性值,多个以/分割。例子:155 / red / largevendor string供应商。例子:Supplierlocationsobject[]
到店取货地点地址信息列表。location_id string取货地点唯一编号。例子:5327026538935748524name string取货地址名称。例子:us.streettype string地点类型。有效枚举值包含:posLocation:POS 渠道创建该订单的门店地点。建议使用posLocationId,因为posLocation后续将废弃。pickupLocation:当订单的配送方式为自提时,自提的门店地点。productLocation:订单中商品的库存地点。建议使用商品行中的location信息,因为productLocation后续将废弃。
name string商家自定义的订单号,从 1001 开始,可以设置前缀。例子:test1001note string商家备注内容。例子:Notesnote_attributesobject[]
商家备注日志。name string卖家标识,表明备注来源。例子:Note sourcevalue string备注内容。例子:Notesorder_source string订单来源渠道的 handle。handle 为语义化标识符。order_status_url string订单状态页 URL。例子:https://shoptest.myshoplinestg.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509payment_detailsobject[]
支付单信息列表。pay_amount string支付金额,以店铺币种金额展示。数值保留到小数点后两位。例子:3.25pay_channel string支付渠道。例子:Paypalpay_channel_deal_id string外部渠道支付流水号。例子:pi_3MI897Hezv8FxjBO1uGxMPhXpay_seq string支付单号。例子:23057287797738260472676128pay_status string支付单状态。有效枚举值包含:unpaid:未支付pending:支付中risking:风控中paid:已支付paid_overtime:支付超时paid_failed:支付失败
phone string买家的手机号。例子:13900000000po_number stringB2B 场景在订单上记录的采购订单号。pos_location_id stringPOS 交易地点 ID。例子:5327026538935748524shipping_addressobject
收货地址。address1 string地址的第一行。通常是街道地址或邮政信箱编号等信息。例子:Address 1address2 string地址的第二行。通常是公寓、套房或单元等信息。例子:Address 2city string地址中的城市。例子:New Yorkcompany string收件人所在的公司名称。例子:New company namecountry string地址中的国家或区域。例子:USAdistrict string地址中的区。例子:Manhattandistrict_code string地址中的区编码。例子:NY100xxfirst_name string收件人的名。例子:Tomlast_name string收件人的姓。例子:Washingtonlatitude string地址所在的纬度。例子:40.7831°Nlongitude string地址所在的经度。例子:73.9712°Wphone string收件人的手机号码。例子:19821119121province string地址中的省份。例子:New York statestandard_province_code string账单地址中省份的编码,该编码为二位的 ISO 3166-2 国际编码,区别于province_code返参为自定义编码。zip string地址的邮编信息。例子:10007status string订单状态。有效枚举值包含:open:订单处理中cancelled:订单已取消
subtotal_price string商品折后价总和,为商品总价 - 营销优惠 - 自定义折扣,以店铺币种展示。例子:4.12tax_linesobject[]
税费明细列表。name string税费名称。例子:taxesprice string税费,以店铺币种展示。数值保留到小数点后两位。例子:3.25rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。例子:taxestax_number string税号。例子:111111111111tax_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商品原价总和,数值保留到小数点后两位,以店铺币种金额展示。例子:3.25total_line_items_price_setobject
商品原价总和,分别以买家币种金额和店铺币种金额展示。total_outstanding string未付款金额总额,数值保留到小数点后两位,以店铺币种金额展示。例子:3.25total_tax string税费总额,数值保留到小数点后两位,以店铺币种金额展示。例子:3.25total_tip_received string小费,数值保留到小数点后两位,以店铺币种金额展示。例子:3.25total_weight string商品总重量,单位:g。例子:1000
API Explorer
调试台
这篇文章对你有帮助吗?