Query draft order

Requires read_draft_orders access scope.
For more info , refer to:
GET https://{handle}.myshopline.com/admin/openapi/v20220901/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: 2505233516032597691280,2505246049176982916464
  • 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.
  • 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
  • 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@test.com
  • first_name string
    User name
    Example: Tom
  • last_name string
    User 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
  • street_number string
    Street encoding , custom numbering
    Example: 4200006
  • zip string
    Shipping address postal number
    Example: 92503
  • 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
  • email string
    User mailbox
  • id string
    User ID
  • phone string
    User mobile phone number
  • id string
    Draft order number
    Example: 2505659131831930856670
  • invoice_url string
    Invoice link
  • 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
  • before_amount string
    Product selling price , double type string for precision 2 , eg : " 12.41 "
    Example: 3.00
  • 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
  • price string
    Product amount after participating in custom discounts
    Example: 2.00
  • 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
  • quantity integer
    Quantity of items in the order
    Example: 1
  • requires_shipping boolean
    Needs physical transportation and delivery or not : true、false
    Example: true
  • taxable boolean
    Tax collection or not : true、false
    Example: true
  • title string
    Product title
  • variant_id string
    Product SKU serial number
    Example: 18056577393793239655103258
  • variant_title string
    Product attribute value
  • logistics_amount string
    Total shipping amount
    Example: 2.00
  • logistics_tax string
    Total shipping tax
    Example: 2.00
  • note string
    Draft order note
    Example: Customer wants to ship asap
  • note_attributesobject[]
    Additional information
  • name string
    Name
  • value string
    value
  • order_id string
    Order number generated by current draft order
    Example: 21056577640603870897253153
  • payment_termsobject
    Payment channel information
  • pay_channel_deal_id string
    External channel payment serial number
  • 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
  • product_tax string
    Product total tax
    Example: 2.00
  • 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
  • city_code string
    City coding , custom number
    Example: Riverside
  • company string
    Company name
  • 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
  • district string
    Administrative region name
  • 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
  • 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
  • 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
  • price string
    Logistics shipping , double type string with accuracy 2
    Example: 12.41
  • shipping_type string
    Logistics type system- system logistics ; custom- custom logistics
    Example: system
  • title string
    Shipping template name
  • 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
  • total_line_items_price string
    Current draft order Product total amount
    Example: 2.00
  • total_price string
    Current total draft order amount , Product selling price-discount + tax + shipping
    Example: 2.00
  • update_by string
    Update account id
    Example: 4201057379
  • update_time long
    Update time , time stamp format
    Example: 1667638652832
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20220901

ParamOptions

— header required
— query
— query
— query
— query
— query
— query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20220901/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'
Examples
Specify draft order number query
Response
{
  "draft_orders": [
    {
      "create_time": 1671423137458,
      "currency": "USD",
      "customer": {
        "email": "1@qq.com",
        "id": "2200013914"
      },
      "id": "2505722624956321243540",
      "invoice_url": "https://us-store.myshopline.com/invoices/2505722624956321243540?secret=E2F0B871FCBD19826B1AAA4B0E7647F7CDD05536593A527355481D945EC675F0",
      "line_items": [
        {
          "gift_card": true,
          "id": "16056866893599248410513562180568668936032749424135620",
          "price": "10.0",
          "product_id": "16056866893599248410513562",
          "quantity": 1,
          "requires_shipping": false,
          "title": "礼品卡商品",
          "variant_id": "18056866893603274942413562",
          "variant_title": "US$10.00"
        }
      ],
      "logistics_amount": "0.0",
      "logistics_tax": "0.0",
      "payment_terms": {
        "pay_channel_deal_id": "5746354571090901118",
        "pay_status": "unpaid",
        "payment_channel_name": "Credit card"
      },
      "product_tax": "0.0",
      "shipping_lines": {
        "price": "0.0"
      },
      "status": "open",
      "stock_reserved": false,
      "total_line_items_price": "10.0",
      "total_price": "10.0",
      "update_time": 1672837771905
    }
  ]
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.

Error loading component.

Error loading component.