Query draft order

Requires read_draft_orders access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20250601/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 .

[]

Draft list

Query Parameters

ids string
[]
Draft order number , multiple separated by ',' and maximum support of 100
[]
Example: 2505749057828590456543, 2505749057828590456543
limit integer
[]
Query of query quantity , default 50 , can not exceed 1000
[]
Example: 10
page_info string
[]
The encrypted request parameters are used for the previous page and the next page, and the field is directly parsed and accessed.
[]
Example: {}
sort_condition string
[]
Sorting : format such as : create_at : desc , id : asc multi sorting and comma segmentation ;Sorting rules : such as create_at : desc , id : asc , first in create_at , and then in order to be create_at ; currently support create_at , id sorting
[]
Example: create_at:desc,id:asc
status string
[]
Draft order status , open- processing , completed- has been completed
[]
Example: open
updated_at_max string
[]
Draft order update time ( end ) ( format see IOS8601 )
[]
Example: 2023-01-05T10:05:45+00:00
updated_at_min string
[]
Draft order update time ( start ) ( format see IOS8601 )
[]
Example: 2023-01-04T10:05:45+00:00

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Response

[]

For more information about status codes, see Http status code.

Response Headers

link
[]
Contain the request parameters of the previous page and the next page
traceId
[]
traceId

Response Body

draft_ordersobject[]
[]
Draft order listing information
billing_addressobject
[]
Payment slip address
address1 string
[]
Detailed address information 1 , used as complementary information
[]
Example: 8899 Garfield Street
address2 string
[]
Detailed address information 2 , used as complementary information
[]
Example: Apartment 5
area string
[]
Administrative region name
[]
Example: East town
area_code string
[]
Administrative district encoding , custom number
[]
Example: 4200006
city string
[]
City name
[]
Example: Riverside
city_code string
[]
City coding , custom number
[]
Example: 4200006
company string
[]
Company name
[]
Example: SHOPLINE
country string
[]
Country name
[]
Example: Usa
country_code string
[]
Country or region code , two ISO-3166-1
[]
Example: US
email string
[]
User mailbox
[]
Example: test@shoplineapp.com
first_name string
[]
User's first name
[]
Example: Tom
last_name string
[]
User's last name
[]
Example: Washington
phone string
[]
Consignee contact
[]
Example: 13100000000
province string
[]
State or provincial name
[]
Example: California
province_code string
[]
State or provincial code , custom number
[]
Example: 4200006
same_as_receiver boolean
[]
Same as receiving information : true、false
[]
Example: true
street_name string
[]
Street name
[]
Example: Street
street_number string
[]
Street encoding , custom numbering
[]
Example: 4200006
zip string
[]
Shipping address postal number
[]
Example: 92503
companyobject
[]
Company info
id string
[]
Company id
[]
Example: 1005619945158043247856
location_id string
[]
Location id
[]
Example: 3005619945158043247856
tax_registration_id string
[]
Tax registration id
[]
Example: 213213
create_by string
[]
Creator account id
[]
Example: 4201057379
create_time long
[]
Create time , time stamp format
[]
Example: 1667638652832
currency string
[]
Store currency
[]
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
[]
User ID
[]
Example: 2200000611
last_name string
[]
User's last name
[]
Example: Wang
phone string
[]
User mobile phone number
[]
Example: 1888888888888
discount_amount_ext string
[]
Order Discount amount
[]
Example: 2.00
discount_amount_ext_setobject
[]
Order Discount amount ( multi-currency )
presentment_moneyobject
[]
Currency information
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
discountable boolean
[]
Whether to combine marketing promotions.
[]
Example: true
id string
[]
Draft order number
[]
Example: 2505659131831930856670
invoice_url string
[]
Invoice link
[]
Example: https://xxxxx.myshopline.com/invoices/xxxx?secret=xxxx
line_itemsobject[]
[]
Listing list
applied_discountobject
[]
Product custom discount information
amount string
[]
Discount amount , double type string for accuracy 2 , eg : " 12.41 "
[]
Example: 1.00
amount_setobject
[]
Discount amount ( multi-currency )
presentment_moneyobject
[]
Currency information
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
before_amount string
[]
Product selling price , double type string for precision 2 , eg : " 12.41 "
[]
Example: 3.00
before_amount_setobject
[]
Product selling price ( multi-currency )
presentment_moneyobject
[]
Currency information
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
description string
[]
Discount description
[]
Example: 5 yuan off for two more pieces
title string
[]
Discount name
[]
Example: Full reduction
value string
[]
Discount amount, discount value, when the discount type is DISCOUNT_AMOUNT_PERCENTAGE, the minimum value is 0 and the maximum value is 100 by default
[]
Example: 1.00
value_type string
[]
Discount type : fixed_amount ( fixed amount ) 、percentage ( % )
[]
Example: fixed_amount
gift_card boolean
[]
Wei for gift cards or not : true、false
[]
Example: true
id string
[]
Product line id , unique confirm a Product line
[]
Example: 100000000
image_url string
[]
picture url
[]
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 ( multi-currency )
presentment_moneyobject
[]
Currency information
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
product_id string
[]
Product s pu serial number
[]
Example: 16056577393789045351043258
product_source string
[]
Product source main_site main station product、customize custom product
[]
Example: main_site
propertiesobject[]
[]
Product customization information
name string
[]
value
[]
Example: value
show boolean
[]
To be displayed on the front end or not
[]
Example: true
type string
[]
Attribute type, text-character, the display format is name: value; picture-picture, the display type is name: get the rendered thumbnail through URLs; link-hyperlink, the display type is name: value, supports clicking on the link to jump to urls First
[]
Example: text-one
urls array
[]
Attribute type, text-character, the display format is name: value; picture-picture, the display type is name: get the rendered thumbnail through URLs; link-hyperlink, the display type is name: value, supports clicking on the link to jump to urls First
[]
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
[]
Needs physical transportation and delivery or not : true、false
[]
Example: true
tax_linesobject[]
[]
Tax information
name string
[]
Tax name
[]
Example: TAX
price string
[]
Tax ( store currency amount ) , accuracy 2
[]
Example: 8.00
price_setobject
[]
Multi-currency information of tax
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
rate double
[]
Tax rate
[]
Example: 1
type string
[]
Tax fee type, used to distinguish between commodity tax and freight tax. The enumeration value is as follows product_tax: commodity tax shipping_tax: freight tax
[]
Example: shipping_tax
taxable boolean
[]
Tax collection or not : true、false
[]
Example: true
title string
[]
Product title
[]
Example: CustomProducts
variant_id string
[]
Product SKU serial number
[]
Example: 18056577393793239655103258
variant_title string
[]
Product attribute value
[]
Example: RED / L
logistics_amount string
[]
Total shipping amount
[]
Example: 2.00
logistics_amount_setobject
[]
Total shipping cost ( multi-currency )
presentment_moneyobject
[]
Currency information
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
logistics_tax string
[]
Total shipping tax
[]
Example: 2.00
logistics_tax_setobject
[]
Total shipping tax ( multi-currency )
presentment_moneyobject
[]
Currency information
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
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
[]
Example: 21056577640603870897253153
payment_termsobject
[]
Payment channel information
created_at string
[]
Create time
[]
Example: 2024-06-05 08:00: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
[]
Example: 2
id string
[]
The unique identifier (ID) that identifies this payment term
[]
Example: 6497210673894431747
overdue boolean
[]
Is the payment term overdue: true/false
[]
Example: true
pay_channel_deal_id string
[]
External channel payment serial number
[]
Example: 5341701129888599091
pay_status string
[]
Payment slip status : after not paying for the paid draft order and generating the order , the payment slip state will not synchronize the payment status of the order
[]
Example: unpaid
payment_channel_name string
[]
Payment channels
[]
Example: Custom payment --uploadfile
payment_schedulesobject[]
[]
A set of schedules associated with the payment terms
completed_at string
[]
Payment completion date
[]
Example: 2024-06-05 08:00:00
due_at string
[]
Expected payment date
[]
Example: 2024-06-05 08:00: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).
[]
Example: 2024-06-05 08:00:00
payment_terms_name string
[]
The name of the payment terms template used to create the payment terms.
[]
Example: Due on receipt
payment_terms_type string
[]
The type of payment terms template used to create the payment terms: FIXED: Merchant specified date FULFILLMENT: Fulfillment (Shipment) completion date NET: Fixed condition date RECEIPT: Billing sent date UNKNOWN: Unknown type
[]
Example: RECEIPT
updated_at string
[]
Update time
[]
Example: 2024-06-05 08:00:00
po_number string
[]
Purchase order number recorded on the order in B2B scenarios
presentment_currency_code string
[]
Market currency
[]
Example: USD
product_tax string
[]
Product total tax
[]
Example: 2.00
product_tax_setobject
[]
Product total tax ( multi-currency )
presentment_moneyobject
[]
Currency information
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
shipping_addressobject
[]
Shipping address information
address1 string
[]
Detailed address information 1 , used as complementary information
[]
Example: 8899 Garfield Street
address2 string
[]
Detailed address information 2 , used as complementary information
[]
Example: Apartment 5
city string
[]
City name
[]
Example: Ashland
city_code string
[]
City coding , custom number
[]
Example: Riverside
company string
[]
Company name
[]
Example: 4200006
country string
[]
Country name
[]
Example: Usa
country_code string
[]
Country or region code , two ISO-3166-1
[]
Example: US
delivery_store_code string
[]
Store code , custom number
[]
Example: 4200006
delivery_store_name string
[]
Store name
[]
Example: xxxx
district string
[]
Administrative region name
[]
Example: xxx
district_code string
[]
Administrative district encoding , custom number
[]
Example: 4200006
first_name string
[]
First name
[]
Example: Tom
last_name string
[]
Last name
[]
Example: Washington
name string
[]
Full name
[]
Example: xxx
phone string
[]
Contact number
[]
Example: 13100000000
province string
[]
State or provincial name
[]
Example: California
province_code string
[]
State or provincial code , custom number
[]
Example: 4200006
street_name string
[]
Street name
[]
Example: Street
street_number string
[]
Street encoding , custom numbering
[]
Example: 4200006
zip string
[]
Shipping address postal number
[]
Example: 92503
shipping_linesobject
[]
Order logistics information
delivery_id string
[]
Shipping method id , shipping template id
[]
Example: 109012039908
price string
[]
Logistics shipping , double type string with accuracy 2
[]
Example: 12.41
price_setobject
[]
Shipping costs ( multi-currency )
presentment_moneyobject
[]
Currency information
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
shipping_type string
[]
Logistics type system- system logistics ; custom- custom logistics
[]
Example: system
title string
[]
Shipping template name
[]
Example: 10 pieces in all areas
status string
[]
Draft order status : open 、 complete
[]
Example: open
stock_reserved boolean
[]
Order dimension inventory reserve mark : true、flase
[]
Example: true
stock_reserved_time long
[]
Order dimension inventory pre-reserved time
[]
Example: 1667638652832
tags array
[]
The draft order tag uses separated by ',' between multiple tag rooms , and the shop dimension supports up to 99 tag
[]
Example: shine,bili
tax_linesobject[]
[]
Tax information
name string
[]
Tax name
[]
Example: TAX
price string
[]
Tax ( store currency amount ) , accuracy 2
[]
Example: 8.00
price_setobject
[]
Multi-currency information of tax
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
rate double
[]
Tax rate
[]
Example: 1
type string
[]
Tax fee type, used to distinguish between commodity tax and freight tax. The enumeration value is as follows product_tax: commodity tax shipping_tax: freight tax
[]
Example: shipping_tax
total_duties_setobject
[]
Total duty
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
total_line_items_price string
[]
Current draft order Product total amount
[]
Example: 2.00
total_line_items_price_setobject
[]
Product total amount ( multi-currency )
presentment_moneyobject
[]
Currency information
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
total_price string
[]
Current total draft order amount , Product selling price-discount + tax + shipping
[]
Example: 2.00
total_price_setobject
[]
Total amount ( multi-currency )
presentment_moneyobject
[]
Currency information
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount
amount string
[]
Amount
[]
Example: 2.00
currency_code string
[]
Currency
[]
Example: USD
update_by string
[]
Update account id
[]
Example: 4201057379
update_time long
[]
Update time , time stamp format
[]
Example: 1667638652832

API Explorer

Debugger

Base URL

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

ParamOptions

Authorization — header required

ids — query

limit — query

page_info — query

sort_condition — query

status — query

updated_at_max — query

updated_at_min — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/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