Get an order count

Requires read_orders access scope.

For more info, refer to:

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

Retrieve the count of orders based on the specified parameters.

Query Parameters

updated_at_min string

Specify the start creation date and time for orders to query. Orders updated on and after this date are counted. Format: ISO 8601.

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

Specify the cutoff creation date and time for orders to query. Orders created on and before this date are counted. Format: ISO 8601.

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

Specify the start creation date and time for orders to query. Orders created on and after this date are counted. Format: ISO 8601.

Example: 2024-08-31T02:20:26+08:00
financial_status string
The payment status of the order. Valid values are:
- unpaid: Order not paid
- authorized: Order payment has been authorized
- pending: Order payment in progress
- partially_paid: Order partially paid
- paid: Order paid
- partially_refunded: Order partially refunded
- refunded: Order refunded
- any: Contains all statuses
Default value: any
fulfillment_status string
The fulfillment status of the order. Valid values are:
- unshipped: Not shipped
- partial: Partially shipped
- shipped: Shipped
- any: All fulfillment statuses
Default value: any
location_id string

Location ID.
order_source string
Sales channel. Valid values are:
- oneshop: One-page store
- web: Online store
- mc: Message center
- live: Live shopping
- post: Post shopping
- shopee: Shopee
- lazada: Lazada
- buy_button: Buy button app
- pos: POS
- any: Contains all sales channels
Default value: any
status string
Order status. Valid values are:
- open: Order in process
- cancelled: Order canceled
- hidden: Order archived
- any: Contains all statuses
Default value: any
updated_at_max string

Specify the cutoff creation date and time for orders to query. Orders updated on and before this date are counted. Format: ISO 8601.

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

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 authorization to 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

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

count long

Order count based on the query parameters.

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

Authorization — header required

updated_at_min — query

created_at_max — query

created_at_min — query

financial_status — query

fulfillment_status — query

location_id — query

order_source — query

status — query

updated_at_max — query

Language

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