Query abandoned order

Requires read_orders access scope.

For more info , refer to:

[]

access permission

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

[]

Abandoned order list

Query Parameters

checkout_tokens string
[]
checkoutTokens
created_at_max string
[]
createdAtMax
created_at_min string
[]
createdAtMin
ids string
[]
ids
limit integer
[]
limit
page_info string
[]
Query parameter secret text
query_page_link_param string
[]
queryPageLinkParam
since_id string
[]
sinceId
sorts object[]
[]
The JSON array encoded by urlencode is passed in, including the following fields:：
- key : sorting field
- sort_type : sorting type ( ascending asc , descending tec )
key string
[]
Sorting fields
sort_type string
[]
sortType
status string
[]
status
updated_at_max string
[]
updatedAtMax
updated_at_min string
[]
updatedAtMin

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
[]
Link
traceId
[]
traceId

Response Body

abandoned_ordersobject[]
[]
abandonedOrders
abandoned_checkout_url string
[]
abandonedCheckoutUrl
billing_addressobject
[]
billingAddress
address1 string
[]
Detailed address 1
[]
Example: 8899 Garfield Street
address2 string
[]
Detailed address 2, optional
[]
Example: Apartment 5
city string
[]
City
company string
[]
Company name
country string
[]
Country \ region
[]
Example: Usa
country_code string
[]
Country \ region code
[]
Example: US
first_name string
[]
First name
[]
Example: Tom
last_name string
[]
Last name
[]
Example: Washington
name string
[]
Full name
phone string
[]
Phone
[]
Example: 13100000000
province string
[]
Zhou \ province
[]
Example: California
province_code string
[]
state\province
[]
Example: 4200006
zip string
[]
Postal code
[]
Example: 92503
checkout_token string
[]
Checkout voucher
close_at string
[]
Closed time
[]
Example: 2022-11-24T18:44:11+08:00
completed_at string
[]
Finish time
[]
Example: 2022-11-24T18:44:11+08:00
created_at string
[]
Creation time
[]
Example: 2022-11-24T18:44:11+08:00
currency string
[]
Settlement currency
[]
Example: USD
customerobject
[]
Customer
addressesobject
[]
address
address1 string
[]
Detailed address 1
[]
Example: 8899 Garfield Street
address2 string
[]
Detailed address 2, optional
[]
Example: Apartment 5
city string
[]
City
[]
Example: Riverside
country string
[]
Country \ region
[]
Example: Usa
country_code string
[]
Country \ region code
[]
Example: US
first_name string
[]
First name
[]
Example: Tom
last_name string
[]
Last name
[]
Example: Washington
name string
[]
Full name
phone string
[]
Phone
[]
Example: 13100000000
province string
[]
state\province
[]
Example: California
province_code string
[]
state\province code
[]
Example: 4200006
zip string
[]
Postal code
[]
Example: 92503
currency string
[]
Currency
[]
Example: USD
email string
[]
Mail
[]
Example: Washingtontest@test.com
first_name string
[]
First name
[]
Example: Tom
id string
[]
User ID
[]
Example: 4211450692
last_name string
[]
Last name
[]
Example: Washington
phone string
[]
Phone
discount_codesobject[]
[]
Promo code information
amount string
[]
amount
[]
Example: 10.00
code string
[]
Promo code
[]
Example: FKSEFIJESZZZ
type string
[]
type
[]
Example: Reduced amount
email string
[]
Buyer's mailbox, there must be one of the two
id string
[]
AbanonedOrder id
[]
Example: 2405686780676835647629
line_itemsobject[]
[]
Product information
price string
[]
Commodity price, precision 2
[]
Example: 1.0
product_id string
[]
SPU serial number
[]
Example: 16053272717023800781363258
quantity integer
[]
Product quantity
[]
Example: 2
sku string
[]
sku
[]
Example: 18053272717023800781363258
note string
[]
Notes
[]
Example: Ship as soon as possible
note_attributesobject[]
[]
Additional information
name string
[]
Name
value string
[]
value
phone string
[]
Buyer contact
presentment_currency string
[]
Buy side currency
[]
Example: USD
recovery_status string
[]
Recall status : not_recovered , recovered
[]
Example: recovered
shipping_addressobject
[]
Shipping address
address1 string
[]
Detailed address 1
[]
Example: 8899 Garfield Street
address2 string
[]
Detailed address 2, optional
[]
Example: Apartment 5
city string
[]
City
[]
Example: Riverside
company string
[]
Company name
country string
[]
Country \ region
[]
Example: Usa
country_code string
[]
Country \ region code
[]
Example: US
first_name string
[]
First name
[]
Example: Tom
last_name string
[]
Last name
[]
Example: Washington
name string
[]
Full name
phone string
[]
Phone
[]
Example: 13100000000
province string
[]
state\province
[]
Example: California
province_code string
[]
state\province Code
[]
Example: 4200006
zip string
[]
Postal code
[]
Example: 92503
shipping_linesobject[]
[]
Logistics information
code string
[]
Logistics name
phone string
[]
Phone
title string
[]
Logistics name
status string
[]
Status
[]
Example: recoverd
subtotal_price string
[]
Product discount total
total_discounts string
[]
Discount total
total_duties string
[]
Total duty
[]
Example: 8.88
total_line_items_price string
[]
Product the original price is combined
total_price string
[]
Total price of order ( deduct Discount with tax )
total_tax string
[]
Tax
updated_at string
[]
Update time
[]
Example: 2022-11-24T18:44:11+08:00
user_id string
[]
Buyer id

API Explorer

Debugger

Base URL

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

ParamOptions

Authorization — header required

checkout_tokens — query

created_at_max — query

created_at_min — query

ids — query

limit — query

page_info — query

query_page_link_param — query

since_id — query

sorts — query

key — query

sort_type — query

status — query

updated_at_max — query

updated_at_min — query

Language

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