查询订单
GET https://{handle}.myshopline.com/admin/openapi/v20260301/orders.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handle 是 open001 。可根据请求条件批量查询订单详细信息,比如根据订单创建时间或者更新时间来查询订单,同步订单数据,也可以指定订单 ID 查询单个订单信息。
查询参数
- updated_at_max string指定截止日期和时间,在此时间或此时间之前更新的订单会被返回。格式:ISO 8601。例子:
2021-08-18T23:59:59+08:00 - buyer_id string下单用户 ID。例子:
4201057495 - created_at_max string指定要查询订单的截止日期和时间,在此时间或此时间之前创建的订单会被返回。格式:ISO 8601。例子:
2021-08-18T23:59:59+08:00 - email string下单用户的 email。例子:
Washingtontest@gmail.com - location string订单中商品被履约的地点 ID(或是 POS 交易点 ID),支持入参多个地点 ID,用逗号隔开。例子:
5453386037065169090, 5564834083287605454 - search_content string搜索内容, 例如订单号、支付流水号、快递单号、商品名称、商品 SKU 货号或订单金额等。例子:
D203 - contract_ids string订阅合同 ID,多个以逗号分隔。最多支持 50 个 ID。例子:
3005619945158043247856 - hidden_order string是否查询已归档订单。
true:查询已归档订单false:查询未归档订单
默认值:false - limit string查询数量限制,数量不能超过 100。默认值:
50 - status string指定订单状态,订单状态包含:
open:处理中cancelled:已取消any:包含任何状态,包括已归档
- updated_at_min string指定截止日期和时间,在此时间或此时间之后更新的订单会被返回。格式:ISO 8601。例子:
2021-08-04T23:59:59+08:00 - ids string订单号,多个以逗号分隔。最多支持 100 个订单号。例子:
21050224312121887324667162, 21050224312121887324667164 - sort_condition string设置查询订单结果的排序规则。可按以下字段进行排序:
order_at(订单创建时间)或ID(订单编号)。每个字段可以指定为升序 (asc)或降序 (desc)。如有多个排序条件,请使用逗号隔开。例如,若将该字段设置为order_at:desc, id:asc,则订单结果将首先按照订单创建时间从新到旧的顺序排列,之后按照订单编号从小到大的顺序排列。例子:order_at:desc - created_at_min string指定要查询订单的截止日期和时间,在此时间或此时间之后创建的订单会被返回。格式:ISO 8601。例子:
2021-08-04T23:59:59+08:00 - fields string指定查询的字段,用逗号分隔,不传则返回所有的字段信息。例子:
id,email,note - financial_status string指定订单支付状态,有效枚举值包含:
unpaid:未支付authorized:已授权pending:支付中partially_paid:部分支付paid:已支付partially_refunded:部分退款refunded:已退款
- fulfillment_status string指定订单发货状态,有效枚举值包含:
unshipped:未发货partial:部分发货shipped:已发货
默认值:unshipped注意:传入枚举值的准确性会进行强校验,如果枚举值校验不通过,则订单查询会失败,会报错fulfillment status value is illegal。 - name string订单编号(和订单 ID 不同,该编号可以在商家后台自定义前缀)。例子:
D2034 - page_info string分页查询的唯一标 识,用于定位特定页面。该字段值需要在你已经查询完分页信息后,在该接口响应头中的
link字段值中获取。例如,你获取到的link的值为<https://{handle}.myshopline.com/admin/openapi/{version}/orders.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next",那么page_info的值为eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9。关于更多如何使用分页信息,请参考 分页机制。 - since_id string要查询的数据的订单号 ID 的起始位置。例子:
21056199447626881527947685
请求头
- Content-Type string required字段值固定为
application/json; charset=utf-8。 - Authorization string required资源的访问令牌。参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。例子:
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
状态码
- 200
- 401
- 429
更多状态码信息,参考 HTTP 状态码。
响应头
link
提供分页数据的 URL 链接。你可以获取该字段值中的page_info信息用于下一次分页请求中。当你请求的页面存在上一页或下一页的时候,该字段会被返回。关于更多如何使用分页信息,请参考 分页机制。traceId
请求的全局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。
响应体
ordersobject[]
订单数据列表。adjust_price stringPOS 交易场景下因金额四舍五入带来的差额金额,用店铺币种。例子:8.00adjust_price_setobject
POS 交易场景下因金额四舍五入带来的差额金额,分别以买家币种和卖家币种展示。billing_addressobject
用于邮寄账单发票的地址。address1 string账单地址的第一行。通常是街道地址或邮政信箱编号等信息。例子:Address 1address2 string账单地址的第二行。通常是公寓、套房或单元等信息。例子:Address 2city string账单地址中的城市。例子:New Yorkcompany string账单收件人所在的公司名称。例子:New company namecountry string账单地址中的国家或区域。例子:USAfirst_name string账单收件人的名。例子:Tomlast_name string账单收件人的姓。例子:Washingtonname string账单收件人的全名。例子:test1001phone string账单收件人的手机号码。例子:13100000000province string账单地址中的省份。例子:Californiastandard_province_code string账单地址中省份的编码,该编码为二位的 ISO 3166-2 国际编码,区别于province_code返参为自定义编码。zip string账单地址的邮编信息。例子:92503browser_ip string买家下单时的浏览器 IP 地址。例子:157.119.232.35buyer_note string买家留言。例子:messagecancel_reason string卖家取消原因。例子:I don't want to buy it.cart_token string购物车数据的唯一标识。例子:c2c4a58186b9d96395d7e6b5c2969577checkout_id string弃单 ID。例子:2404785166526352972864checkout_token string弃单数据的唯一标识,C 端用户发起结算,会生成弃单 。例子:c2c4a58186b9d96395d7e6b5c2969577client_detailsobject
客户端详细信息。browser_ip string买家下单时的浏览器 IP 地址。例子:157.119.232.35session_hash string会员会话加密信息。例子:c2c4a58186b9d96395d7e6b5c2969577user_agent string客户端代理。例子:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Sacompanyobject
买家下单时买家所在的公司信息。id string公司 ID。例子:1005619945158043247856location_id string地点 ID。例子:3005619945158043247856tax_registration_id string税号信息。例子:213213contract_seq string订阅合同号。例子:3005619945158043247856credit_limitobject
信用支付信息。is_credit_limit boolean订单是否使用了信用支付。true:有使用false:未使用
outstanding_credit_limit string占用的信用额度总和。初始和total_credit_limit相等,如果后续有类似还款操作,占用的额度则相应减少。例子:1.00total_credit_limit string使用的信用额度总和,即该笔订单用了多少信用额度支付。例子:1.00current_subtotal_price string商品金额总和,为商品单价 * 数量,以店铺币种展示。例子:78.0current_subtotal_price_setobject
商品金额总和,为商品单价 * 数量,分别以买家币种和店铺币种展示。current_total_discounts string折扣金额总和,数值保留到小数点后两位,为营销优惠 + 人工折扣,以店铺币种展示。例子:1.00current_total_discounts_setobject
折扣金额总和,数值保留到小数点后两位,为营销优惠 + 人工折扣,分别以买家币种金额和店铺币种金额展示。current_total_duties_setobject
商品总关税,分别以买家币种金额和店铺币种金额展示。current_total_price string订单总额,以店铺币种金额展示。例子:60.0current_total_price_setobject
订单总额,分别以买家币种金额和店铺币种金额展示。current_total_tax string税费金额总和,以店铺币种金额展示。例子:1.00customerobject
买家信息。addressesobject
买家地址信息。address1 string买家地址的第一行。通常是街道地址或邮政信箱编号等信息。例子:Wandaaddress2 string买家地址的第二行。通常是公寓、套房或单元等信息。例子:65788city string买家地址中的城市。例子:Yangquan Citycountry string买家地址中的国家或区域。例子:Chinafirst_name string买家地址中收件人的名。例子:Tomlast_name string买家地址中收件人的姓。例子:Washingtonname string买家地址中收件人的全名。例子:D203phone string买家地址中收件人手机号。例子:13100000000province string买家地址中的省份。例子:Shanxi Provincezip string买家地址的邮编信息。例子:521000area_code string国家或地区的手机区号。例子:+86email string买家的邮箱地址。例子:Washingtontest@gmail.comfirst_name string买家的名。例子:Tomid string买家 ID。例子:4201057495last_name string买家的姓。例子:Washingtonphone string买家的手机号。例子:13100000000deduct_member_point_amount string当前订单会员积分抵扣金额,以店铺币种展示。数值保留到小数点后两位。例子:8.00deduct_member_point_amount_setobject
当前订单会员积分抵扣金额,分别以买家币种金额和店铺币种金额展示。discount_applicationsobject[]
折扣信息列表。activity_type integer商品行享受的活动类型:0:满减满折、免邮1:限时促销2:捆绑组合3:优惠码4:一页商店5:赠品活动6:预售7:加购品8:礼品盒9:商品追售活动
allocation_method string折扣的范围。有效枚举值包含:across:按照购买总数折扣each:按照单个商品分别折扣
示例:如一次购买三个相同的商品,折扣为 10 元。如果allocation_method为across代表三个一起减 10 元;如果allocation_method为each代表每个减 10 元。benefit_type integer商品行享受的优惠类型:-1:无优惠1:减金额2:打折3:免运费4:加价品5:任意N件优惠价6:A+B组合优惠价7:赠品8:固定售价9:最低价商品免费11:第N件打折12:买x送y13:自定义14:N件M元
code string折扣码。