批量查询弃单
GET https://{handle}.myshopline.com/admin/openapi/v20260301/orders/abandoned_orders.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handle 是 open001 。批量查询店铺的弃单列表。你可以使用该接口查询生成的弃单、已经归档的弃单。
查询参数
- since_id string弃单号的 ID。传入该值后,会从指定的弃单号 ID 开始查询弃单。例子:
2405747245402807605252 - limit string查询数量限制。
默认值:20
取值范围:0-100 - sorts string弃单的排序方式。传入 URL 编码后的 JSON 数组,包含以下字段:
key:排序字段sort_type:排序类型(升序 asc、降序 desc)
- updated_at_max string指定要查询弃单的截止更新日期和时间。在此时间和此时间之前更新的弃单会被返回。格式:ISO 8601。例子:
2024-08-31T02:20:26+08:00 - checkout_tokens string弃单的唯一凭证,多个以英文逗号分隔,最多可传入 100 个。
- ids string弃单的唯一标识,多个以英文逗号分隔,最多可传入 100 个。
- page_info string分页查询的唯一标识,用于定位特定页面。该字段值需要在你已经查询完分页信息后,在该接口响应头中的
link字段值中获取。例如,你获取到的link的值为<https://{handle}.myshopline.com/admin/openapi/{version}/orders/abandoned_orders.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next",那么page_info的值为eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9。关于更多如何使用分页信息,请参考 分页机制。 - query_page_link_param string废弃:该字段自 API 版本 V20240601 起已废弃。
- status string弃单的状态。有效值如下:
draft:买家未在结算页填写联系邮箱或手机号。open:买家已在结算页填写联系邮箱或手机号,但尚未生成订单。recovered:买家已在结算页填写联系邮箱或手机号,系统已发送召回邮件,且已生成订单。
- created_at_max string指定要查询弃单的截止创建日期和时间。在此时间和此时间之前创建的弃单会被返回。格式:ISO 8601。例子:
2024-08-31T02:20:26+08:00 - created_at_min string指定要查询弃单的起始创建日期和时间。在此时间和此时间之后创建的弃单会被返回。格式:ISO 8601。例子:
2024-08-31T02:20:26+08:00 - updated_at_min string指定要查询弃单的起始更新日期和时间。在此时间和此时间之后更新的弃单会被返回。格式:ISO 8601。例子:
2024-08-31T02:20:26+08:00
请求头
- 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
请求的全局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。
响应体
abandoned_ordersobject[]
弃单列表信息。abandoned_checkout_url string弃单关联的结账页链接。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。standard_province_code string账单地址中省份的编码,该编码为二位的 ISO 3166-2 国际编码,区别于province_code返参为自定义编码。zip string账单地址的邮编信息。checkout_token string弃单的唯一凭证。例子:c2c4a57472e5e0c8a760f2f2f9c5c8b6close_at string弃单关闭时间。格式:ISO 8601。关闭流程包含以下两种方式:- 自动关闭:若 60 天内未完成订单,系统将自动关闭该弃单。
- 订单生成:通过该弃单生成订单时,将触发关闭操作。
例子:2024-08-31T02:20:26+08:00customerobject
弃单用户信息。addressesobject
用户的地址。address1 string地址的第一行。通常是街道地址或邮政信箱编号等信息。address2 string地址的第二行。通常是公寓、套房或单元等信息。city string地址中的城市。country string地址中的国家或地区。first_name string收件人的名。last_name string收件人的姓。name string收件人全名。phone string收件人的手机号码。province string地址中的州或省。province_code string地址中州或省的编码,该编码可以是自定义编号或者为二位的 ISO 3166-2 国际编码。zip string地址的邮编信息。email string用户的联系邮箱。first_name string收件人的名。id string用户的唯一标识符 ID。last_name string收件人的姓。phone string收件人的手机号码。discount_codesobject[]
折扣信息列表。amount string活动的优惠金额。数值保留到小数点后两位,以presentment_currency对应的币种展示。code string折扣码,非折扣码时为空。例子:FKSEFIJESZZZtype string折扣类型,有效枚举值包括:-1:无优惠1:减金额2:打折3:免运费4:加价品5:任意 N 件优惠价6:A+B 组合优惠价7:赠品8:固定售价9:最低价商品免费11:第 X 件打折12:买 X 送 Y13:自定义14:N 件 M 元
email string下单用户的联系邮箱。id string弃单的唯一标识符 ID。line_itemsobject[]
商品信息。image string商品图片的 URL 地址。price string商品金额。数值保留到小数点后两位。product_id string商品的唯一标识符 ID。quantity integer商品数量。sku string系统定义的商品 SKU 序列号。例子:18051197729580850196772413title string商品标题。note string消费者备注。note_attributesobject[]
商家附加备注信息。name string商家附加备注信息的名称。value string商家附加备注信息的值。phone string下单人的手机号码。recovery_status string弃单的召回状态。有效值如下:not_recovered:表示弃单已发送召回邮件,但未产生完成订单。recovered:表示弃单发送召回邮件后,已成功转化为完成订单。
shipping_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地址中州或省的编码,该编码可以是自定义编号或者为二位的 ISO 3166-2 国际编码。standard_province_code string地址中省份的编码,该编码为二位的 ISO 3166-2 国际编码,区别于province_code返参为自定义编码。zip string收货地址中的邮编信息。shipping_linesobject[]
收货地址信息。code string运费模板编码,当值为Local delivery时表示本地配送。phone string本地配送地点的商户联系电话。title string运费方案名称。status string弃单的状态。有效值如下:draft:买家未在结算页填写联系邮箱或手机号。open:买家已在结算页填写联系邮箱或手机号,但尚未生成订单。recovered:买家已在结算页填写联系邮箱或手机号,系统已发送召回邮件,且已生成订单。
subtotal_price string商品优惠后的金额。数值保留到小数点后两位。返回金额对应的币种为presentment_currency的返回值。total_discounts string折扣总金额。数值保留到小数点后两位。返回金额对应的币种为presentment_currency的返回值。total_duties string总关税。数值保留到小数点后两位。返回金额对应的币种为presentment_currency的返回值。total_line_items_price string所有商品优惠后的总金额。数值保留到小数点后两位。返回金额对应的币种为presentment_currency的返回值。total_price string打折后的订单总金额,包括运费和税费。数值保留到小数点后两位。返回金额对应的币种为presentment_currency的返回值。total_tax string订单总税费金额。数值保留到小数点后两位。返回金额对应的币种为presentment_currency的返回值。user_id string用户的唯一标识符 ID。
API Explorer
调试台
示例代码
这篇文章对你有帮助吗?