查询草稿单

需要 read_draft_orders 权限点。

更多权限点使用信息，请参考：

GET https://{handle}.myshopline.com/admin/openapi/v20260301/orders/draft_orders.json

handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。

根据指定条件查询草稿单信息。

查询参数

checkout_ids string

弃单的唯一标识 ID，多个使用英文逗号拼接，最大支持100个。

例子: 2505749057828590456543, 2505749057828590456543
ids string

草稿单的唯一标识符 ID，查询多个使用英文逗号拼接。

最大个数限制：100

例子: 10
page_info string

分页查询的唯一标识，用于定位特定页面。

该字段值需要在你已经查询完分页信息后，在该接口响应头中的 link 字段值中获取。例如，你获取到的 link 的值为 <https://{handle}.myshopline.com/admin/openapi/{version}/orders/draft_orders.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next" ，那么 page_info 的值为 eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9 。

关于更多如何使用分页信息，请参考分页机制。

例子: 7AFD7393C6E7CF18672C038477E2EF6A463464BDBAF766DD8F8CB8E0085F82419A94B80084BCDA0B838B3F13C302A2C9044E
sort_condition string

排序规则。例如：create_at:desc,id:asc，先按 create_at 倒序，再按 id 正序。

例子: create_at:desc,id:asc
updated_at_max string

草稿单更新时间的查询截止点。需与 updated_at_min 配合使用，共同确定查询的时间区间。时间格式遵循 ISO 8601 国际标准。

例子: 2023-01-05T10:05:45+00:00
limit string

查询数量限制。

默认值：50

取值范围：0-1000

例子: 50
status string
草稿单状态。有效枚举值包含：
- open：处理中
- completed：已完成
例子: open
updated_at_min string

草稿单更新时间的查询起始点。需与 updated_at_max 配合使用，共同确定查询的时间区间。时间格式遵循 ISO 8601 国际标准。

例子: 2023-01-04T10:05:45+00:00

请求头

Content-Type string required

字段值固定为 application/json; charset=utf-8。
Authorization string required

资源的访问令牌。参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
例子:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

状态码

更多状态码信息参考 HTTP 状态码。

响应头

link

提供分页数据的 URL 链接。你可以获取该字段值中的 page_info 信息用于下一次分页请求中。

当你请求的页面存在上一页或下一页的时候，该字段会被返回。关于更多如何使用分页信息，请参考分页机制。
traceId

请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。

响应体

draft_ordersobject[]

草稿单列表信息。
billing_addressobject

支付账单地址。
address1 string

支付账单地址的第一行。通常是街道地址或邮政信箱编号等信息。
例子: 8899 Garfield Street
address2 string

支付账单地址的第二行。通常是公寓、套房或单元等信息。
例子: Apartment 5
area string

支付账单地址中的行政区名称。
例子: East town
area_code string

支付账单地址中的行政区编码，自定义编号。
例子: 4200006
city string

支付账单地址的城市。
例子: Riverside
city_code string

支付账单地址中城市的编码。
例子: 4200006
company string

公司名称。
例子: SHOPLINE
country string

支付账单地址的国家或地区。
例子: Usa
country_code string

支付账单地址的国家或地区编码。遵循 ISO 3166-1 国际标准的二位国家或区域码，用于识别市场所在的国家或地区。例如：US。
例子: US
email string

账单收件人的邮箱。
例子: test@shoplineapp.com
first_name string

账单收件人的名。
例子: Tom
last_name string

账单收件人的姓。
例子: Washington
phone string

账单收件人的联系方式。
例子: 13100000000
province string

账单地址中的州或省。
例子: California
province_code string

支付账单地址中省份的编码，该编码可以是自定义编号或者为二位的 ISO 3166-2 国际编码。
例子: California
same_as_receiver boolean

该地址是否与收货信息相同。

true: 相同

false: 不同

例子: true
standard_province_code string

账单地址中省份的编码，该编码为二位的 ISO 3166-2 国际编码，区别于province_code返参为自定义编码。
street_name string

街道名称。
例子: Street
street_number string

街道编码，自定义编号。
例子: 4200006
zip string

收货地址邮政编号。
例子: 92503
checkout_ids string

弃单的唯一标识 ID，多个使用英文逗号拼接。
companyobject

公司信息。
id string

公司的唯一标识符 ID。
例子: 1005619945158043247856
location_id string

公司地点的唯一标识符 ID。
例子: 3005619945158043247856
tax_registration_id string

税号。
例子: 213213
create_by string

创建人账号编码。
例子: 4201057379
create_time long

草稿单创建的时间。格式：ISO 8601。

例子：2021-08-31T02:20:26+08:00
例子: 1667638652832
currency string

店铺币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
例子: USD
customerobject

买家信息。
area_code string

买家联系地址的区号。
例子: 0000
email string

用户邮箱。
例子: xxx@gmail.com
first_name string

用户的名。
例子: Xiaoliu
id string

用户的唯一标识符 ID。
例子: 2200000611
last_name string

用户的姓。
例子: Wang
phone string

用户手机号。
例子: 1888888888888
discount_amount_ext string

订单优惠金额，以店铺币种金额展示。
例子: 2.00
discount_amount_ext_setobject

订单优惠金额，分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

买家侧金额信息。
amount string

买家侧金额。数值保留到小数点后两位。例如，88.98。
例子: 2.00
currency_code string

买家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
例子: USD
shop_moneyobject

卖家侧金额信息。
amount string

卖家侧金额。数值保留到小数点后两位。例如，88.98。
例子: 2.00
currency_code string

卖家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
例子: USD
discountable boolean

是否叠加营销优惠。

true: 叠加

false: 不叠加

默认值：false
例子: true
id string

草稿单的唯一标识符 ID。
例子: 2505659131831930856670
invoice_url string

Invoice 链接。
例子: https://xxxxx.myshopline.com/invoices/xxxx?secret=xxxx
line_itemsobject[]

商品行信息列表。
applied_discountobject

商品自定义折扣信息。
amount string

折扣金额，数值保留到小数点后两位。例如，88.98。
例子: 1.00
amount_setobject

折扣金额，分别以买家币种金额和店铺币种金额展示。以店铺币种金额展示。
presentment_moneyobject

买家侧金额信息。
amount string

买家侧金额，数值保留到小数点后两位。例如，88.98。
例子: 2.00
currency_code string

买家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
例子: USD
shop_moneyobject

卖家侧金额信息。
amount string

卖家侧金额。数值保留到小数点后两位。例如，88.98。
例子: 2.00
currency_code string

卖家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
例子: USD
before_amount string

商品售价，数值保留到小数点后两位。例如，88.98。
例子: 3.00
before_amount_setobject

商品售价，分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

买家侧金额信息。
amount string

买家侧金额。数值保留到小数点后两位。例如，88.98。
例子: 2.00
currency_code string

买家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
例子: USD
shop_moneyobject

卖家侧金额信息。
amount string

卖家侧金额。数值保留到小数点后两位。例如，88.98。
例子: 2.00
currency_code string

卖家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
例子: USD
description string

折扣描述。
例子: 5 yuan off for two more pieces
title string

折扣名称。
例子: Full reduction
value string

折扣数额，当折扣类型为 DISCOUNT_AMOUNT_PERCENTAGE 时，此值最大默认100，最小为0。
例子: 1.00
value_type string

折扣值的类型。有效枚举值包含：

fix_amount：固定金额

percentage：百分比

例子: fixed_amount
gift_card boolean

该商品是否为礼品卡商品。

true: 是礼品卡商品

false: 不是礼品卡商品

例子: true
id string

商品行的唯一标识符 ID。
例子: 100000000
image_url string

图片链接。
例子: http://www.abc.com/123
price string

商品参加自定义折扣后的金额。
例子: 2.00
price_setobject

商品参加自定义折扣后的金额。分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

买家侧金额信息。
amount string

买家侧金额。数值保留到小数点后两位。例如，88.98。
例子: 2.00
currency_code string

买家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
例子: USD
shop_moneyobject

卖家侧金额信息。
amount string

卖家侧金额。数值保留到小数点后两位。例如，88.98。
例子: 2.00
currency_code string

卖家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
例子: USD
product_id string

商品 SPU 序列号。
例子: 16056577393789045351043258
product_source string

商品来源。有效枚举值包含：

main_site：主站商品

customize：自定义商品

例子: main_site
propertiesobject[]

商品定制信息。
name string

定制名称。
例子: value
show boolean

该信息是否要在前端展示。

true: 展示

false: 不展示

例子: true
type string

附加信息类型。有效枚举值包含：

text：文本类型

picture：图片类型

link：链接类型

例子: text-one
urls array

附加信息类型跳转链接。
例子: ["https://image.baidu.com/search/detail?ct=503316480&z=0&ipn=d&word=%E5%9B%BE%E7%89%87&hs=0&pn=0&spn=0"]
value string

自定义属性值。
例子: value
quantity integer

订单中的商品数量。
例子: 1
requires_shipping boolean

商品是否需要实物运输发货。

true: 需要发货

false: 不需要发货

默认值：true
例子: true
sku string

商家定义的商品货号。
tax_linesobject[]

该商品税费信息。
name string

税费名称。
例子: TAX
price string

税费金额。商品实际收税以此字段金额为准。
例子: 8.00
price_setobject

税费价格信息。分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

买家侧金额信息。
amount string

买家侧金额。数值保留到小数点后两位。例如，88.98。
例子: 8.00
currency_code string

买家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
例子: USD
shop_moneyobject

卖家侧金额信息。
amount string

卖家侧金额。数值保留到小数点后两位。例如，88.98。
例子: 8.00
currency_code string

卖家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
例子: USD
rate double

税率。
例子: 1
type string

税费类型，用于区分商品税和运费税。有效枚举值包含：

product_tax：商品税

shipping_tax：运费税

例子: shipping_tax
taxable boolean

该商品是否含税。

true：含税

false：不含税

默认值：ture
例子: true
title string

该商品的标题。
例子: CustomProducts
variant_id string

商品的 SKU 序列号，商品款式的唯一标识 ID。
例子: 18056577393793239655103258
variant_title string

商品属性值。
例子: RED / L
logistics_amount string

运费总金额。数值保留到小数点后两位。例如，88.98。
例子: 2.00
logistics_amount_setobject

运费总金额。分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

买家侧金额信息。
amount string

买家侧金额。数值保留到小数点后两位。例如，88.98。
例子: 2.00
currency_code string

买家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
例子: USD
shop_moneyobject

卖家侧金额信息。
amount string

卖家侧金额。数值保留到小数点后两位。例如，88.98。
例子: 2.00
currency_code string

卖家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
例子: USD
logistics_tax string

运费总税费。
例子: 2.00
logistics_tax_setobject

运费总税费。分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

买家侧金额信息。
amount string

买家侧金额。数值保留到小数点后两位。例如，88.98。
例子: 2.00
currency_code string

买家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
例子: USD
shop_moneyobject

卖家侧金额信息。
amount string

卖家侧金额。数值保留到小数点后两位。例如，88.98。
例子: 2.00
currency_code string

卖家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
例子: USD
market_name string

市场名称。
例子: Usa market
market_region_country_code string

市场国家。
例子: US
note string

草稿单备注。
例子: Customer wants to ship asap
note_attributesobject[]

附加信息。
name string

名称。
例子: xxxx
value string

值。
例子: 2
order_id string

由当前草稿单生成的订单单号
payment_termsobject

支付条款和付款信息。
created_at string

支付条款创建时间。格式：ISO 8601。

例子：2024-08-31T02:20:26+08:00
due_in_days integer

当条款类型为 NET 时提供，多少天后未付款则到期。
id string

唯一识别该支付条款的 ID。
overdue boolean

支付条款是否超时。

true：超时

false：未超时

pay_channel_deal_id string

外部渠道支付流水号。
pay_status string

支付单状态。有效枚举值包含：

unpaid：未支付

paid：已支付

草稿单生成订单后，该状态不会同步订单的支付状态。
payment_channel_name string

支付渠道。
payment_schedulesobject[]

与付款条件相关联的一组时间表。
completed_at string

付款完成时间。格式：ISO 8601。

例子: 2024-08-31T02:20:26+08:00
due_at string

预计付款时间。格式：ISO 8601。

例子: 2024-08-31T02:20:26+08:00
issued_at string

付款条件启动的时间。当为 FIXED 时，为保存时间（若草稿单成单，则订单继承草稿单时间）；当为 FULFILLMENT/RECEIPT 时，为条件生效时间；当为 NET 时，则为保存时间（若草稿单成单，则订单继承草稿单时间）。
payment_terms_name string

用于创建付款条件的付款条件模板的名称。
payment_terms_type string

用于创建付款条件的付款条件模板类型。有效枚举值包含：

FIXED：商家指定日期

FULFILLMENT：完成发货日期

NET：固定条件日期

RECEIPT：发送账单日期

UNKNOWN：未知类型

updated_at string

支付条款的更新时间。格式：ISO 8601。

例子: 2024-08-31T02:20:26+08:00
po_number string

B2B 场景在订单上记录的采购订单号。
presentment_currency_code string

市场币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
product_tax string

商品总税费。
product_tax_setobject

商品总税费。分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

买家侧金额信息。
amount string

买家侧金额。数值保留到小数点后两位。例如，88.98。
currency_code string

买家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
shop_moneyobject

卖家侧金额信息。
amount string

卖家侧金额。数值保留到小数点后两位。例如，88.98。
currency_code string

卖家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
shipping_addressobject

收货地址信息。
address1 string

收货人详细地址的第一行。通常是街道地址或邮政信箱编号等信息。
address2 string

收货人详细地址的第二行。通常是公寓、套房或单元等信息。
city string

收货地址中的城市。
city_code string

收货地址中城市的编码。
company string

公司名称。
country string

国家或是地区名称
country_code string

收货地址中国家的二位国家码，遵循 ISO 3166-1 国际标准，例如：US。
delivery_store_code string

门店编码，自定义编号。
delivery_store_name string

门店名称。
district string

收货地址中的区。
district_code 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返参为自定义编码。
street_name string

街道名称。
street_number string

街道编码，自定义编号。
zip string

收货地址邮政编号。
shipping_linesobject

订单物流信息。
delivery_id string

送货方式 ID。
price string

物流运费。数值保留到小数点后两位。例如，88.98。
price_setobject

物流运费。分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

买家侧金额信息。
amount string

买家侧金额。数值保留到小数点后两位。例如，88.98。
currency_code string

买家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
shop_moneyobject

卖家侧金额信息。
amount string

卖家侧金额。数值保留到小数点后两位。例如，88.98。
currency_code string

卖家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
shipping_type string

物流类型。有效枚举值包含：

system：系统物流

custom：自定义物流

title string

运费模板名称。
status string

草稿单状态。有效枚举值包含：

open：处理中

completed：已完成
stock_reserved boolean

订单维度库存返还类型。有效枚举值包含：

no_restock：未返还

cancel：取消

return：返还
stock_reserved_time long

订单维度库存预预留时间。
tags array

草稿单标签，多个标签间用逗号分隔，店铺维度最大支持 99 个标签。
tax_linesobject[]

草稿单税费信息。
name string

税费名称。
price string

税费金额。商品实际收税以此字段金额为准。
price_setobject

价格信息。分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

买家侧金额信息。
amount string

买家侧金额。数值保留到小数点后两位。例如，88.98。
currency_code string

买家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
shop_moneyobject

卖家侧金额信息。
amount string

卖家侧金额。数值保留到小数点后两位。例如，88.98。
currency_code string

卖家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
rate double

税率。该信息只做展示作用。
type string

税费类型，用于区分商品税和运费税。有效枚举值包含：

product_tax：商品税

shipping_tax：运费税
total_duties_setobject

总关税。
presentment_moneyobject

买家侧金额。
amount string

买家侧金额。数值保留到小数点后两位。例如，88.98。
currency_code string

买家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
shop_moneyobject

卖家侧金额信息。
amount string

卖家侧金额。数值保留到小数点后两位。例如，88.98。
currency_code string

卖家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
total_line_items_price string

当前草稿单商品总金额。
total_line_items_price_setobject

商品总金额。分别以买家币种金额和店铺币种金额展示。
presentment_moneyobject

买家侧金额信息。
amount string

买家侧金额。数值保留到小数点后两位。例如，88.98。
currency_code string

买家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
shop_moneyobject

卖家侧金额信息。
amount string

卖家侧金额。数值保留到小数点后两位。例如，88.98。
currency_code string

卖家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。

Example: USD
total_price string

商品金额总和，为商品总价 * 数量，以店铺币种展示。
total_price_setobject

商品金额总和，为商品总价 * 数量，分别以买家币种和店铺币种展示。
presentment_moneyobject

买家侧金额信息。
amount string

买家侧金额。数值保留到小数点后两位。例如，88.98。
currency_code string

买家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
shop_moneyobject

卖家侧金额信息。
amount string

卖家侧金额。数值保留到小数点后两位。例如，88.98。
currency_code string

卖家侧币种。该字段值为三位币种码，遵循 ISO 4217 标准。例如：USD。
update_by string

更新人账号编码。
update_time long

草稿单更新时间。格式：ISO 8601。

例子：2024-08-31T02:20:26+08:00

API Explorer

调试台

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

Authorization — header required

checkout_ids — query

ids — query

page_info — query

sort_condition — query

updated_at_max — query

limit — query

status — query

updated_at_min — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/orders/draft_orders.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

这篇文章对你有帮助吗？

SHOPLINE

条款协议