Query draft order

Requires read_draft_orders access scope.

For more info, refer to:

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

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Query information of the draft order according to specified conditions.

Query Parameters

updated_at_max string

Set the query end point for the draft order update time. This should be used in conjunction with updated_at_min to define the query time range. Format: ISO 8601.

Example: 2023-01-05T10:05:45+00:00
updated_at_min string

Set the query start point for the draft order update time. This should be used in conjunction with updated_at_max to define the query time range. Format: ISO 8601.

Example: 2023-01-04T10:05:45+00:00
ids string

The unique identifier for the draft order, multiple IDs should be separated by commas.

Maximum size: 100

Example: 10
status string
Draft order status. Valid values are:
- open: processing
- completed: has been completed
Example: open
checkout_ids string

Draft order number, multiple separated by ',' and maximum support of 100.

Example: 2505749057828590456543, 2505749057828590456543
limit string

Query the quantity limit of draft orders.

Default value: 50

Value range: 0-1000

Example: 50
page_info string

The unique identifier for pagination queries, used to locate a specific page.

This parameter value is obtained from the link value in the response header of this API after you have queried the pagination information.

For example, if the link value you obtained is <https://{handle}.myshopline.com/admin/openapi/{version}/orders/draft_orders.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next" , the value of page_info is eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9 .

For more information on how to use pagination, refer to Paging Mechanism.

Example: 7AFD7393C6E7CF18672C038477E2EF6A463464BDBAF766DD8F8CB8E0085F82419A94B80084BCDA0B838B3F13C302A2C9044E
sort_condition string

Sorting rule. For fields like create_at:desc,id:asc, first sort in descending order by create_at, and then sort in ascending order by id.

Example: create_at:desc,id:asc

Request Headers

Content-Type string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorizationto obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

link

The URL link that provides the pagination data. You can obtain page_info from this parameter for subsequent pagination requests.

This parameter is returned when the requested page has a previous or next page.

For more information on how to use pagination, refer to Paging Mechanism.
traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

draft_ordersobject[]

Draft order listing information.
billing_addressobject

Payment billing address.
address1 string

The first line of the payment billing address. This typically includes information such as the street address or a post office box number.
Example: 8899 Garfield Street
address2 string

The second line of the payment billing address. This typically includes information such as apartment, suite, or unit number.
Example: Apartment 5
area string

The administrative region name in payment billing address.
Example: East town
area_code string

The code for administrative district, custom number.
Example: 4200006
city string

The city in the payment billing address.
Example: Riverside
city_code string

The code for city in the payment billing address.
Example: 4200006
company string

Company name.
Example: SHOPLINE
country string

The country in the payment billing address.
Example: Usa
country_code string

The country code in the payment billing address. A two-letter country or region code that follows the ISO 3166-1 standard, used to identify a specific market's country or region. For example, US.
Example: US
email string

The bill recipient's email address.
Example: test@shoplineapp.com
first_name string

The bill recipient's first name.
Example: Tom
last_name string

The bill recipient's last name.
Example: Washington
phone string

The bill recipient's contact information.
Example: 13100000000
province string

The province in the address
Example: California
province_code string

The code for the province in the payment billing address, which can be a custom code or a two-digit ISO 3166-2 international code.
Example: California
same_as_receiver boolean

Indicates whether the address is the same as the shipping information.

true: same

false: different

Example: true
standard_province_code string

The code for the province in the billing address, which is a two-digit ISO 3166-2 international code.This differs from province_code - the province_code response field uses a custom code.
street_name string

Street name.
Example: Street
street_number string

Street encoding, custom numbering.
Example: 4200006
zip string

Shipping address postal number.
Example: 92503
checkout_ids string

The unique identifier for abandoned orders, multiple of which are concatenated with commas.
companyobject

Company information.
id string

The unique identifier for the company.
Example: 1005619945158043247856
location_id string

The unique identifier for the company location.
Example: 3005619945158043247856
tax_registration_id string

Tax registration ID.
Example: 213213
create_by string

Creator account ID.
Example: 4201057379
create_time long

The date and time when the draft order was created. Format: ISO 8601.

Example: 2024-08-31T02:20:26+08:00
Example: 1667638652832
currency string

The store currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
Example: USD
customerobject

Buyer information.
area_code string

Contact area ID.
Example: 0000
email string

User mailbox.
Example: xxx@gmail.com
first_name string

User's first name.
Example: Xiaoliu
id string

The unique identifier for the user.
Example: 2200000611
last_name string

User's last name.
Example: Wang
phone string

User mobile phone number.
Example: 1888888888888
discount_amount_ext string

The discount amount, displayed in the store's currency.
Example: 2.00
discount_amount_ext_setobject

The discount amount, displayed in both the buyer's currency and the store's currency.
presentment_moneyobject

Buyer-side amount information.
amount string

Buyer-side amount. The value is rounded to two decimal places. For example, 88.98.
Example: 2.00
currency_code string

The buyer-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
Example: USD
shop_moneyobject

Merchant-side amount information.
amount string

Merchant-side amount. The value is rounded to two decimal places. For example, 88.98.
Example: 2.00
currency_code string

The merchant-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
Example: USD
discountable boolean

Indicates whether marketing discounts can be stacked.

true: stacked

false: not stacked

Defalut value: false
Example: true
id string

The unique identifier for the draft order.
Example: 2505659131831930856670
invoice_url string

Invoice link.
Example: https://xxxxx.myshopline.com/invoices/xxxx?secret=xxxx
line_itemsobject[]

A list of product line information.
applied_discountobject

Product custom discount information.
amount string

The discount amount. The value is rounded to two decimal places. For example, 88.98.
Example: 1.00
amount_setobject

The discount amount，displayed in both the buyer's currency and the store's currency.
presentment_moneyobject

Buyer-side amount information.
amount string

Buyer-side amount. The value is rounded to two decimal places. For example, 88.98.
Example: 2.00
currency_code string

The buyer-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
Example: USD
shop_moneyobject

Merchant-side amount information.
amount string

Merchant-side amount. The value is rounded to two decimal places. For example, 88.98.
Example: 2.00
currency_code string

The merchant-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
Example: USD
before_amount string

The product price. The value is rounded to two decimal places. For example, 88.98.
Example: 3.00
before_amount_setobject

The product price, displayed in both the buyer's currency and the store's currency.
presentment_moneyobject

Buyer-side amount information.
amount string

Buyer-side amount. The value is rounded to two decimal places. For example, 88.98.
Example: 2.00
currency_code string

The buyer-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
Example: USD
shop_moneyobject

Merchant-side amount information..
amount string

Merchant-side amount. The value is rounded to two decimal places. For example, 88.98.
Example: 2.00
currency_code string

The merchant-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
Example: USD
description string

The discount description.
Example: 5 yuan off for two more pieces
title string

The discount title.
Example: Full reduction
value string

Discount amount. When the discount type is DISCOUNT_AMOUNT_PERCENTAGE, the maximum default value of this amount is 100, and the minimum value is 0.
Example: 1.00
value_type string

The type of value. Valid values are:

fix_amount: fixed amount discount

percentage: percentage discount

Example: fixed_amount
gift_card boolean

Indicates whether the product is a gift card item.

true: gift card item

false: not a gift card item

Example: true
id string

The unique identifier for the product line.
Example: 100000000
image_url string

Product image link.
Example: http://www.abc.com/123
price string

Product amount after participating in custom discounts.
Example: 2.00
price_setobject

Product amount after participating in custom discounts, displayed in both the buyer's currency and the store's currency.
presentment_moneyobject

Buyer-side amount information.
amount string

Buyer-side amount. The value is rounded to two decimal places. For example, 88.98.
Example: 2.00
currency_code string

The buyer-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
Example: USD
shop_moneyobject

Merchant-side amount information.
amount string

Merchant-side amount. The value is rounded to two decimal places. For example, 88.98.
Example: 2.00
currency_code string

The merchant-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
Example: USD
product_id string

Product SPU serial number.
Example: 16056577393789045351043258
product_source string

Product source. Valid values are:

main_site: main station product

customize: custom product

Example: main_site
propertiesobject[]

Product customization information.
name string

Custom name.
Example: value
show boolean

Indicates whether this message should be displayed on the frontend.

true: displayed

false: not displayed

Example: true
type string

Property type. Valid values are:

text：text type

picture：picture type

link：link type

Example: text-one
urls array

The URL for the additional information type redirection.
Example: ["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

Custom attribute values.
Example: value
quantity integer

Quantity of items in the order.
Example: 1
requires_shipping boolean

Indicates whether the product is subject to physical shipping.

true: required

false: not required

Default value: true
Example: true
sku string

A unique identifier for the item in the fulfillment. Applicable only to custom line items.
tax_linesobject[]

The returned product tax information.
name string

Tax name.
Example: TAX
price string

The tax amount. The actual tax collected on the product is based on this field value.
Example: 8.00
price_setobject

Multi-currency information of tax, displayed in both the buyer's currency and the store's currency.
presentment_moneyobject

Buyer-side amount information.
amount string

Buyer-side amount. The value is rounded to two decimal places. For example, 88.98.
Example: 8.00
currency_code string

The buyer-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
Example: USD
shop_moneyobject

Merchant-side amount information.
amount string

Merchant-side amount. The value is rounded to two decimal places. For example, 88.98.
Example: 8.00
currency_code string

The merchant-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
Example: USD
rate double

The tax rate.
Example: 1
type string

Tax fee type, used to distinguish between commodity tax and freight tax. Valid values are:

product_tax: commodity tax

shipping_tax: freight tax

Example: shipping_tax
taxable boolean

Indicates whether the product is taxable.

true：taxable

false：not taxable

Default value: true
Example: true
title string

The title of the product.
Example: CustomProducts
variant_id string

The SKU of the product. The unique identifier for the product style.
Example: 18056577393793239655103258
variant_title string

Product attribute value.
Example: RED / L
logistics_amount string

Total shipping amount. The value is rounded to two decimal places. For example, 88.98.
Example: 2.00
logistics_amount_setobject

Total shipping cost, displayed in both the buyer's currency and the store's currency.
presentment_moneyobject

Buyer-side amount information.
amount string

Buyer-side amount. The value is rounded to two decimal places. For example, 88.98.
Example: 2.00
currency_code string

The buyer-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
Example: USD
shop_moneyobject

Merchant-side amount information.
amount string

Merchant-side amount. The value is rounded to two decimal places. For example, 88.98.
Example: 2.00
currency_code string

The merchant-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
Example: USD
logistics_tax string

Total shipping tax.
Example: 2.00
logistics_tax_setobject

Total shipping tax, displayed in both the buyer's currency and the store's currency.
presentment_moneyobject

Buyer-side amount information.
amount string

Buyer-side amount. The value is rounded to two decimal places. For example, 88.98.
Example: 2.00
currency_code string

The buyer-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
Example: USD
shop_moneyobject

Merchant-side amount information.
amount string

Merchant-side amount. The value is rounded to two decimal places. For example, 88.98.
Example: 2.00
currency_code string

The merchant-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
Example: USD
market_name string

Market name.
Example: Usa market
market_region_country_code string

Market country.
Example: US
note string

Draft order note.
Example: Customer wants to ship asap
note_attributesobject[]

Additional information.
name string

Name.
Example: xxxx
value string

Value.
Example: 2
order_id string

Order number generated by current draft order.
payment_termsobject

Payment channel information.
created_at string

The date and time when the payment term is created. Format: ISO 8601.

Example: 2024-08-31T02:20:26+08:00
due_in_days integer

When the terms type is NET, the payment is due after how many days if the payment is not made.
id string

The unique identifier (ID) that identifies this payment term.
overdue boolean

Indicates whether the payment terms have expired.

true：expired

false：not expired

pay_channel_deal_id string

External channel payment serial number.
pay_status string

Payment order status. Valid values are:

unpaid: unpaid

paid: paid

After a draft order is generated into an order, this status will not synchronize with the payment status of the order.
payment_channel_name string

Payment channels.
payment_schedulesobject[]

A set of schedules associated with the payment terms.
completed_at string

Payment completion date. Format: ISO 8601.

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

Expected payment date. Format: ISO 8601.

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

The time when the payment terms are triggered. When the type is FIXED, it is the saved time (if the draft order becomes an order, the order inherits the draft order time); when the type is FULFILLMENT/RECEIPT, it is the effective time of the condition; when the type is NET, it is the saved time (if the draft order becomes an order, the order inherits the draft order time).
payment_terms_name string

The name of the payment terms template used to create the payment terms.
payment_terms_type string

The type of payment terms template used to create the payment terms. Valid values are:

FIXED: Merchant specified date.

FULFILLMENT: Fulfillment (Shipment) completion date.

NET: Fixed condition date.

RECEIPT: Billing sent date.

UNKNOWN: Unknown type.

updated_at string

The date and time when the payment term is last updated. Format: ISO 8601.

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

Purchase order number recorded on the order in B2B scenarios.
presentment_currency_code string

Market currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
product_tax string

Product total tax.
product_tax_setobject

Product total tax, displayed in both the buyer's currency and the store's currency.
presentment_moneyobject

Buyer-side amount information.
amount string

Buyer-side amount. The value is rounded to two decimal places. For example, 88.98.
currency_code string

The buyer-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject

Merchant-side amount information.
amount string

Merchant-side amount. The value is rounded to two decimal places. For example, 88.98.
currency_code string

The merchant-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
shipping_addressobject

Shipping address information.
address1 string

The first line of the address. This typically includes information such as the street address or a post office box number.
address2 string

The second line of the address. This typically includes information such as apartment, suite, or unit number.
city string

The city in the shipping address.
city_code string

The code for city in the shipping address.
company string

Company name.
country string

Country name.
country_code string

A two-letter country or region code that follows the ISO 3166-1 standard, used to identify a specific country or region in the address. For example, US.
delivery_store_code string

Store code, custom number.
delivery_store_name string

Store name.
district string

District of the shipping address.
district_code string

The code for district in of the shipping address.
first_name string

The first name of the recipient.
last_name string

The last name of the recipient.
name string

The name of the recipient.
phone string

Contact number.
province string

The province in the address.
province_code string

The code for the province in the shipping address, which can be a custom code or a two-digit ISO 3166-2 international code.
standard_province_code string

The code for the province in the shipping address, which is a two-digit ISO 3166-2 international code.This differs from province_code - the province_code response field uses a custom code.
street_name string

Street name.
street_number string

Street encoding, custom numbering.
zip string

Shipping address postal number.
shipping_linesobject

Order logistics information.
delivery_id string

Shipping method ID.
price string

Logistics shipping. The value is rounded to two decimal places. For example, 88.98.
price_setobject

Shipping costs, displayed in both the buyer's currency and the store's currency.
presentment_moneyobject

Buyer-side amount information.
amount string

Buyer-side amount. The value is rounded to two decimal places. For example, 88.98.
currency_code string

The buyer-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject

Merchant-side amount information.
amount string

Merchant-side amount. The value is rounded to two decimal places. For example, 88.98.
currency_code string

The merchant-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
shipping_type string

Logistics type system. Valid values are:

system: system logistics

custom: custom logistics

title string

Shipping template name.
status string

Draft order status. Valid values are:

open: processing

completed: has been completed
stock_reserved boolean

Inventory return type. Valid values are:

no_restock: not returned

cancel: canceled

return: returned
stock_reserved_time long

Order dimension inventory pre-reserved time.
tags array

The draft order tag uses separated by ',' between multiple tag rooms, and the shop dimension supports up to 99 tag.
tax_linesobject[]

The draft order tax information.
name string

Tax information.
price string

The tax amount. The actual tax collected on the product is based on this field value.
price_setobject

Multi-currency information of tax, displayed in both the buyer's currency and the store's currency.
presentment_moneyobject

Buyer-side amount information. The value is rounded to two decimal places. For example, 88.98.
amount string

Buyer-side amount. The value is rounded to two decimal places. For example, 88.98.
currency_code string

The buyer-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject

Merchant-side amount information.
amount string

Merchant-side amount. The value is rounded to two decimal places. For example, 88.98.
currency_code string

The merchant-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
rate double

The tax rate, for display only.
type string

Tax fee type, used to distinguish between commodity tax and freight tax. Valid values are:

product_tax: commodity tax

shipping_tax: freight tax
total_duties_setobject

Total duty.
presentment_moneyobject

Buyer side amount information.
amount string

Buyer-side amount. The value is rounded to two decimal places. For example, 88.98.
currency_code string

The buyer-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject

Merchant-side amount information.
amount string

Merchant-side amount. The value is rounded to two decimal places. For example, 88.98.
currency_code string

The merchant-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
total_line_items_price string

Current draft order Product total amount.
total_line_items_price_setobject

Product total amount, displayed in both the buyer's currency and the store's currency.
presentment_moneyobject

Buyer-side amount information.
amount string

Buyer-side amount. The value is rounded to two decimal places. For example, 88.98.
currency_code string

The buyer-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject

Merchant-side amount information.
amount string

Merchant-side amount. The value is rounded to two decimal places. For example, 88.98.
currency_code string

The merchant-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard.

Example: USD.
total_price string

The total amount of the products, calculated as the product of the unit price and quantity, displayed in the store's currency.
total_price_setobject

The total amount of the products, calculated as the product of the unit price and quantity, displayed in both the buyer's currency and the store's currency.
presentment_moneyobject

Buyer-side amount information.
amount string

Buyer-side amount. The value is rounded to two decimal places. For example, 88.98.
currency_code string

The buyer-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject

Merchant-side amount information.
amount string

Merchant-side amount. The value is rounded to two decimal places. For example, 88.98.
currency_code string

The merchant-side currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
update_by string

Update account ID.
update_time long

The date and time when the draft order is last updated. Format: ISO 8601.

Example: 2024-08-31T02:20:26+08:00

API Explorer

Debugger

Base URL

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

ParamOptions

Authorization — header required

updated_at_max — query

updated_at_min — query

ids — query

status — query

checkout_ids — query

limit — query

page_info — query

sort_condition — 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'

Was this article helpful to you?

SHOPLINE

Legal