创建订单
POST https://{handle}.myshopline.com/admin/openapi/v20270301/orders.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handle 是 open001 。创建订单。
请求头
- Content-Type string required字段值固定为
application/json; charset=utf-8。 - Authorization string required资源的访问令牌。参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。例子:
Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA
请求体
orderobject required
订单信息。buyer_note string买家留言。例子:messagefulfillment_status string订单的发货状态。有效枚举值包含:unshipped:未发货shipped:已发货
默认值:unshipped注意:传入枚举值的准确性会进行强校验,如果枚举值校验不通过,则订单会创建失败,会报错fulfillment_status is invalid。line_itemsobject[] required
订单商品快照信息列表。title string商品标题。例子:beautiful skirtlocation_id string商品库存地点 ID。例子:5445886274929439997propertiesobject[]
商品定制信息列表。value string自定义属性值例子:attribute valuename string自定义属性名称例子:attribute nameshow boolean定制信息是否可见:true:可见false:不可见 默认值:false
type string定制信息类型。有效枚举值包含:text:字符类型picture:图片类型link:链接类型
urls arrayURL 资源列表。- 如果
type是picture,可通过urls获取渲染出缩略图。 - 如果
type是link,那么超链接为urls的第一个。
例子:["[\"https://www.url.com\"]"]quantity long商品数量。例子:1taxable boolean该商品是否需要收税。true:需要收税false:不需要收税
默认值:truevariant_id string分配给库存中某一特定商品的唯一编码。例子:18056761559987524812644011discount_priceobject
商品自定义折扣明细。amount string折扣金额。数值保留到小数点后两位。例子:1.00title string折扣名称。例子:Discount nameprice string商品售价,数值保留到小数点后两位。例子:3.25product_id string款式对应商品的唯一标识 ID。例子:16056761559984840457934011requires_shipping boolean表明商品是否需要运输。true:需要运输false:不需要运输
shipping_line_title string商品行匹配的运费方案标题。在传入shipping_lines情况下,当前字段必传。tax_lineobject
自定义商品税费信息。price string税费金额。商品实际收税以此字段金额为准,传入的rate税费仅做展示作用。例子:3.25rate string税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。例子:Tax nameprice_infoobject required
价格信息。taxes_included boolean该订单是否包含税费金额。true:包含税费金额false:不包含税费金额
total_shipping_price string运费,以店铺币种展示。数值保留到小数点后两位。例子:8.00current_extra_total_discounts string订单折扣金额,不包含折扣码优惠。数值保留到小数点后两位。例子:8.00shipping_addressobject
收货地址信息。area string收货地址中的区或县。最大长度限制:64例子:Panyu Districtarea_code string收货地址中区或县的编码。例子:510006latitude string收货地址所在的纬度。例子:43phone string收件人的手机号码。例子:13903004000city_code string收货地址中城市的编码。例子:510000longitude string收货地址所在的经度。例子:34province string收货地址中的州或省份。例子:Guangdong Provinceaddress2 string收货地址的第二行。通常是公寓、套房或单元等信息。最大长度限制:255例子:Apartment 5city string收货地址中的城市。最大长度限制:64例子:Guangzhou Cityemail string买家的邮箱地址。例子:test001@Gmail.comlast_name string收件人的姓。最大长度限制:64例子:Washingtonzip string收货地址的邮编信息。例子:510036address1 string收货地址的第一行。通常是街道地址或邮政信箱编号等信息。最大长度限制:255例子:Xiaoguwei Streetcompany string收件人的公司名称。例子:Company Namecountry string收货地址中的国家或区域。最大长度限制:64例子:Chinafirst_name string收件人的名。最大长度限制:64例子:Tomshipping_lineobject
运费信息。code string物流编号。例子:SFprice string运费金额,数值保留到小数点后两位。例子:3.25tax_lineobject
自定义商品税费信息。title string税费说明标题。该信息只做展示作用。例子:Tax nameprice string税费金额。商品实际收税以此字段金额为准,传入的rate税费仅做展示作用。例子:100rate string税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string运费名称。例子:Shipping nameshipping_linesobject[]
运费方案列表。 最大个数限制:10title string运费名称。price string运费金额tax_lineobject
运费税费明细price string税费金额rate string税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。billing_addressobject
用于邮寄账单发票的地址。city string账单地址中的城市。最大长度限制:64例子:Guangzhou Citycompany string账单收件人的公司名称。例子:Company Namephone string账单收件人的手机号码。例子:13903004000same_as_receiver boolean表示账单地址billing_address是否与收货地址shipping_address是一样的。address1 string账单地址的第一行。通常是街道地址或邮政信箱编号等信息。最大长度限制:256例子:Xiaoguwei Streetaddress2 string账单地址的第二行。通常是公寓、套房或单元等信息。最大长度限制:256例子:Apartment 5country string账单地址中的国家或地区。最大长度限制:64例子:Chinalast_name string账单收件人的姓。例子:Washingtonprovince string账单地址中的省份。例子:Guangdong Provincecity_code string账单地址中城市的编码。例子:510000zip string账单地址的邮编信息。例子:510036area string账单地址中的区或县。最大长度限制:64例子:Panyu Districtarea_code string账单地址中区或县的编码。例子:510007email string账单收件人的邮箱。例子:test001@Gmail.comfirst_name string账单收件人的名。例子:Tomfinancial_status string订单的付款状态。有效枚举值包含:unpaid:未支付partially_paid:部分支付paid:已完成支付
默认值:unpaid注意:传入枚举值的准确性会进行强校验,如果枚举值校验不通过,则订单创建会失败,会报错financial_status is invalid。inventory_behaviour string在订单创建过程中库存的处理方式。有效枚举值包含:bypass:不处理库存。在创建订单时,系统不会对库存进行任何操作,库存数量不会发生变化。decrement_ignoring_policy:扣减库存。不受商家配置的库存策略影响。decrement_obeying_policy:按照商家配置的库存策略扣减库存。
send_fulfillment_receipt boolean是否发送订单发货邮件。true: 发送false:不发送
send_receipt boolean是否发送订单确认邮件。true: 发送false:不发送
company_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.1245name string订单编号(和订单 ID 不同,该编号可以在商家后台自定义前缀)。例子:D101order_note string商家订单备注。最大长度限制:50例子:Notesnote string订单备注。最大长度限制:50废弃:该字段自 API 版本 v20210901 起已废弃。例子:Notesnote_attributesobject[]
商家备注日志列表。name string商家 ID,表明备注来源。例子:Note sourcevalue string备注内容。例子:Notestransaction_listobject[]
支付单列表。amount string支付单金额。数值保留到小数点后两位。例子:3.25gateways string支付渠道。例子:PayPalstatus string required支付状态。有效枚举值包含:unpaid: 未支付failure:支付失败success:支付成功error:支付出错
例子:stringtransactionsobject
支付单信息。id string支付方式 ID。例子:424243
状态码
- 200
- 401
- 429
更多状态码信息,参考 HTTP 状态码。
响应头
traceId
请求的全局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。
响应体
orderobject
订单信息。note_attributesobject[]
商家备注日志。name string卖家标识,表明备注来源。例子:Note sourcevalue string备注内容。例子:Notespo_number stringB2B 场景在订单上记录 的采购订单号。tax_type string订单的税费类型。有效枚举值包含:product_tax:商品税shipping_tax:运费税
total_line_items_price string商品原价总和,数值保留到小数点后两位,以店铺币种金额展示。例子:3.25total_line_items_price_setobject
商品原价总和,分别以买家币种金额和店铺币种金额展示。total_tip_received string小费,数值保留到小数点后两位,以店铺币种金额展示。例子:3.25current_subtotal_price string商品金额总和,为商品单价 * 数量,以店铺币种展示。例子:7.12current_total_duties_setobject
商品总关税,分别以买家币种金额和店铺币种金额展示。name string商家自定义的订单号,从 1001 开始,可以设置前缀。例子:test1001payment_detailsobject[]
支付单信息列表。pay_seq string支付单号。例子:23057287797738260472676128pay_status string支付单状态。有效枚举值包含:unpaid:未支付pending:支付中risking:风控中paid:已支付paid_overtime:支付超时paid_failed:支付失败
pay_amount string支付金额,以店铺币种金额展示。数值保留到小数点后两位。例子:3.25pay_channel string支付渠道。例子:Paypalpay_channel_deal_id string外部渠道支付流水号。例子:pi_3MI897Hezv8FxjBO1uGxMPhXpos_location_id stringPOS 交易地点 ID。例子:5327026538935748524tax_number string税号。例子:111111111111current_total_tax string税费金额总和,以店铺币种金额展示。例子:2.41customerobject
买家信息。area_code string国家或地区的手机区号。例子:+86email string买家的邮箱地址。例子:test001@Gmail.comfirst_name string买家的名。例子:Tomid string买家 ID。例子:4201057495last_name string买家的姓。例子:Washingtonphone string买家的手机号。例子:13100000000order_status_url string订单状态页 URL。例子:https://shoptest.myshoplinestg.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509subtotal_price string