查询订单
GET https://{handle}.myshopline.com/admin/openapi/v20261201/orders.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handle 是 open001 。可根据请求条件批量查询订单详细信息,比如根据订单创建时间或者更新时间来查询订单,同步订单数据,也可以指定订单 ID 查询单个订单信息。
查询参数
- location string订单中商品被履约的地点 ID(或是 POS 交易点 ID),支持入参多个地点 ID,用逗号隔开。例子:
5453386037065169090, 5564834083287605454 - since_id string要查询的数据的订单号 ID 的起始位置。例子:
21056199447626881527947685 - sort_condition string设置查询订单结果的排序规则。可按以下字段进行排序:
order_at(订单创建时间)或ID(订单编号)。每个字段可以指定为升序 (asc)或降序 (desc)。如有多个排序条件,请使用逗号隔开。例如,若将该字段设置为order_at:desc, id:asc,则订单结果将首先按照订单创建时间从新到旧的顺序排列,之后按照订单编号从小到大的顺序排列。例子:order_at:desc - buyer_id string下单用户 ID。例子:
4201057495 - created_at_max string指定要查询订单的截止日期和时间,在此时间或此时间之前创建的订单会被返回。格式:ISO 8601。例子:
2021-08-18T23:59:59+08:00 - hidden_order string是否查询已归档订单。
true:查询已归档订单false:查询未归档订单
默认值:false - name string订单编号(和订单 ID 不同,该编号可以在商家后台自定义前缀)。例子:
D2034 - search_content string搜索内容, 例如订单号、支付流水号、快递单号、商品名称、商品 SKU 货号或订单金额等。例子:
D203 - status string指定订单状态,订单状态包含:
open:处理中cancelled:已取消any:包含任何状态,包括已归档
- updated_at_min string指定截止日期和时间,在此时间或此时间之后更新的订单会被返回。格式:ISO 8601。例子:
2021-08-04T23:59:59+08:00 - financial_status string指定订单支付状态,有效枚举值包含:
unpaid:未支付authorized:已授权pending:支付中partially_paid:部分支付paid:已支付partially_refunded:部分退款refunded:已退款
- fulfillment_status string指定订单发货状态,有效枚举值包含:
unshipped:未发货partial:部分发货shipped:已发货
默认值:unshipped注意:传入枚举值的准确性会进行强校验,如果枚举值校验不通过,则订单查询会失败,会报错fulfillment status value is illegal。 - updated_at_max string指定截止日期和时间,在此时间或此时间之前更新的订单会被返回。格式:ISO 8601。例子:
2021-08-18T23:59:59+08:00 - created_at_min string指定要查询订单的截止日期和时间,在此时间或此时间之后创建的订单会被返回。格式:ISO 8601。例子:
2021-08-04T23:59:59+08:00 - email string下单用户的 email。例子:
Washingtontest@gmail.com - limit string查询数量限制,数量不能超过 100。默认值:
50 - page_info string分页查询的唯一标识,用于定位特定页面。该字段值需要在你已经查询完分页信息后,在该接口响应头中的
link字段值中获取。例如,你获取到的link的值为<https://{handle}.myshopline.com/admin/openapi/{version}/orders.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next",那么page_info的值为eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9。关于更多如何使用分页信息,请参考 分页机制。 - contract_ids string订阅合同 ID,多个以逗号分隔。最多支持 50 个 ID。例子:
3005619945158043247856 - fields string指定查询的字段,用逗号分隔,不传则返回所有的字段信息。例子:
id,email,note - ids string订单号,多个以逗号分隔。最多支持 100 个订单号。例子:
21050224312121887324667162, 21050224312121887324667164
请求头
- Content-Type string required字段值固定为
application/json; charset=utf-8。 - Authorization string required资源的访问令牌。参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。例子:
Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA
状态码
- 200
- 401
- 429
更多状态码信息,参考 HTTP 状态码。
响应头
traceId
请求的全局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。link
提供分页数据的 URL 链接。你可以获取该字段值中的page_info信息用于下一次分页请求中。当你请求的页面存在上一页或下一页的时候,该字段会被返回。关于更多如何使用分页信息,请参考 分页机制。
响应体
ordersobject[]
订单数据列表。current_subtotal_price string商品金额总和,为商品单价 * 数量,以店铺币种展示。例子:78.0discount_codesobject[]
优惠码信息列表。amount string优惠金额,以店铺币种展示,数值保留到小数点后两位。例子:8.00code string优惠码。例子:KIN4GNAB2FRHtype string优惠类型。有效枚举值包含:减金额:全场满 100 元立减 10 元打折:全场满 100 元打 9 折免运费:满 3 件免运费加价品:需要支付额外金额任意N件优惠价:任意买 3 件商品,只需 99 元A+B组合优惠价:同时买 A 商品和 B 商品,两件一起只需 88 元赠品:购买制定商品赠送额外商品固定售价:统一售价 29 元最低价商品免费:买 3 件商品,最便宜的那件免费打包价:多件商品组合以固定总价出售第N件打折:第 2 件打 8 折买x送y:满 2 件送 1 件自定义:自定义折扣
废弃:该字段自 API 版本 v20241201 起已废弃。locationsobject[]
到店取货地点地址信息列表。town string地址中的乡或镇。例子:townzip string地址的邮编信息。例子:521000address string地址的第一行。通常包含街道地址或邮政信箱编号等信息。例子:Address 1address_add string地址的第二行。通常是公寓、套房或单元等信息。例子:Address 22city string地址中的城市。例子:Guangzhoudistrict string地址中的区或县。例子:Panyu Districtprovince string地址中的省份。例子:Guangdong Provincetype string地点类型。有效枚举值包含:posLocation:POS 渠道创建该订单的门店地点。建议使用posLocationId,因为posLocation后续将废弃 。pickupLocation:当订单的配送方式为自提时,自提的门店地点。productLocation:订单中商品的库存地点。建议使用商品行中的location信息,因为productLocation后续将废弃。
country string地址中的国家或区域。例子:Chinalocation_id string取货地点唯一编号。例子:5327026538935748524name string取货地址名称。例子:Wanda squarephone string电话号码。例子:13100000000tags string订单标签。例子:Labelcart_token string购物车数据的唯一标识。例子:c2c4a58186b9d96395d7e6b5c2969577deduct_member_point_amount_setobject
当前订单会员积分抵扣金额,分别以买家币种金额和店铺币种金额展示。financial_status string订单付款状态。有效枚举值包含:unpaid:未支付authorized:已授权pending:处理中partially_paid:部分付款paid:已付款partially_refunded:部分退款refunded:已退款
shipping_linesobject[]
运费列表。code string只有本地配送运费方案有值,返回Local delivery。例子:Local deliverydiscount_allocationsobject[]
折扣明细列表。amount string折扣金额,以店铺币种展示。数值保留到小数点后两位。例子:8.00discount_application_index integer标明商品行应用的折扣在orders.discount_applications中的位置。例子:1discounted_price string折扣金额,以店铺币种展示。数值保留到小数点后两位。例子:8.00price string运费,以店铺币种展示。数值保留到小数点后两位。例子:8.00shipping_price string原运费金额值,非折扣后金额,以店铺币种展示。数值保留到小数点后两位。例子:8.00tax_linesobject[]
税费信息列表。rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。例子:Tax nameprice string税费,以店铺币种展示。数值保留到小数点后两位。例子:8.00title string物流公司名称。例子:SF Internationalphone string买家的手机号。例子:13100000000requested_fulfillment_service_id string运输服务代号。shipping_strategy_name string运输策略名称,当发货方式为SHIPPING或LOCAL_DELIVERY,才有对应的值。source string物流承运商类型。有效枚举值包含:Shipper:Shipper 物流Oneship:Oneship 物流Api:通过开放能力添加的承运商的物流null:系统物流或自定义物流
total_discounts string订单折扣总和,为营销折扣 + 自定义折扣,数值保留到小数点后两位,以店铺币种金额展示。废弃:该字段自 API 版本 v20210901 起已废弃。例子:3.25landing_site string记录完整的订单归因落地页的链接。例子:https://www.url.comphone string买家的手机号。例子:18978789878adjust_price stringPOS 交易场景下因金额四舍五入带来的差额金额,用店铺币种。例子:8.00checkout_token string弃单数据的唯一标识,C 端用户发起结算,会生成弃单 。例子:c2c4a58186b9d96395d7e6b5c2969577credit_limitobject
信用支付信息。total_credit_limit string使用的信用额度总和,即该笔订单用了多少信用额度支付。例子:1.00is_credit_limit boolean订单是否使用了信用支付。true:有使用false:未使用
outstanding_credit_limit string占用的信用额度总和。初始和total_credit_limit相等,如果后续有类似还款操作,占用的额度则相应减少。例子:1.00fulfillment_status string发货状态。有效枚举值包含:fulfilled:已发货partial:部分发货null:未发货
line_itemsobject[]
订单商品快照信息列表。dutiesobject[]
关税信息。harmonized_system_code string海关编码,用于在国际贸易中对产品进行分类。例子:A0023id string关税编号。例子:H2325tax_linesobject[]
税费信息列表。rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。rate_percentage double税率,以百分比数值形式表示,数值保留到小数点后两位。如果税率为2%,该值为2.00。该信息只做展示作用。title string税费标题,该信息只做展示作用。例子:Tax titletitle string商品标题。例子:beautiful skirtdiscount_allocationsobject[]
营销折扣金额,分别以买家币种金额和店铺币种金额展示。discount_application_index integer标明商品行应用的折扣在orders.discount_applications中的位置。例子:1amount string营销折扣金额,数值保留到小数点后两位。例子:8.00fulfillment_status string商品发货状态。有效枚举值包含:fulfilled:已发货partial:部分发货null:未发货
propertiesobject[]
商品定制信息列表。role_visibility string定制信息可见对象:customer: 仅对买家可见merchant: 仅对商家可见all:同时对买家和商家可见none: 同时对买家和商家不可见
show boolean定制信息是否可见type string定制信息类型。有效枚举值包含:text:字符类型picture:图片类型link:链接类型
urls arrayURL 资源列表。- 如果
type是picture,可通过urls获取渲染出缩略图。 - 如果
type是link,那么超链接为urls的第一个。
例子:["[\"https://www.url.com\"]"]value string自定义属性值。例子:attribute valueadditional string定制商品附加字段,比如当name为文字,additional可以附加文字的字号、字体、颜色等。例子:Additional fieldsname string自定义属性名称。例子:Attribute nametax_linesobject[]
税费明细列表。price string税费,以店铺币种展示。数值保留到小数点后两位。例子:8.00rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。例子:taxestype string税费用类型,用于区分是商品税还是运费税。product_tax:商品税shipping_tax:运费税
is_bundle boolean是否为套装商品:true:套装商品 false:非套装商品variant_id string分配给库存中某一特定商品的唯一编码。例子:18056761559987524812644011variant_title string商品属性值,多个以/分割。例子:bigis_bundle_component boolean是否为套装子商品:true:子商品 false:非子商品vendor string供应商。例子:Suppliertaxable boolean该商品是否需要收税。true:需要收税false:不需要收税
customized_attributesobject[]
商品自定义的属性。key string自定义属性名称。由外部传入,但只有key为businessType时,value为下单时系统主动生成,值为3。value string商品自定义属性值,当key为businessType时,只透出值为3(表示赠品)。fulfillment_service string物流商名称。例子:SF Internationalgift_card boolean是否为礼品卡商品。true:是礼品卡商品false:不是礼品卡商品
name stringSKU 标题,该字段值和title一致。例子:Product titleprice string商品售价,以店铺币种金额展示,数值保留到小数点后两位。例子:8.00tags string商品标签,多个以逗号隔开。例子:watchfulfillable_quantity integer剩余可发货数量。例子:1product_id string款式对应商品的唯一标识 ID。例子:16056761559984840457934011attribute string款式规格信息,以款式名称和规格值拼接展示。例子:color - redgrams double重量,单位:g。例子:100harmonized_system_code string海关编码,用于在国际贸易中对产品进行分类。例子:harmonized system codeid string商品快照表的 ID,系统生成,与订单号order.id唯一确认一个商品。例子:417image_url string商品图片的 URL 地址。例子:https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969requires_shipping boolean商品是否需要发货。true:需要发货false:不需要发货
location_id string本地配送地点编号或普通配送地点编号。