Skip to content

Get order statistics

GET
/stores/{storeRef}/orders/statistics
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/orders/statistics \
--header 'x-api-key: <x-api-key>'

Returns the store’s order counts by order, fulfillment, shipping and payment status, plus total revenue (paid and captured orders), average order value and the number of distinct customers.

Required scopes: read:orders

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
total_orders
required

Number of orders in the store.

number
by_order_status
required

Order counts by order status.

object
pending
required

Orders awaiting confirmation.

number
confirmed
required

Confirmed orders.

number
processing
required

Orders being processed.

number
cancelled
required

Cancelled orders.

number
on_hold
required

Orders on hold.

number
completed
required

Completed orders.

number
by_fulfillment_status
required

Order counts by fulfillment status.

object
unfulfilled
required

Orders not yet fulfilled.

number
fulfilled
required

Fulfilled orders.

number
returned
required

Returned orders.

number
return_requested
required

Orders with a return requested.

number
by_shipping_status
required

Order counts by shipping status.

object
not_shipped
required

Orders not yet shipped.

number
shipped
required

Shipped orders.

number
in_transit
required

Orders in transit.

number
out_for_delivery
required

Orders out for delivery.

number
delivered
required

Delivered orders.

number
delivery_failed
required

Orders whose delivery failed.

number
by_payment_status
required

Order counts by payment status.

object
pending
required

Orders awaiting payment.

number
authorized
required

Orders with an authorized payment.

number
paid
required

Paid orders.

number
captured
required

Orders with a captured payment.

number
failed
required

Orders whose payment failed.

number
refunded
required

Refunded orders.

number
voided
required

Orders whose payment was voided.

number
total_revenue
required

Revenue from orders that are paid or captured.

number
avg_order_value
required

Average order value.

number
unique_customers
required

Number of distinct customers who placed orders.

number

Example generated

{
"total_orders": 1,
"by_order_status": {
"pending": 1,
"confirmed": 1,
"processing": 1,
"cancelled": 1,
"on_hold": 1,
"completed": 1
},
"by_fulfillment_status": {
"unfulfilled": 1,
"fulfilled": 1,
"returned": 1,
"return_requested": 1
},
"by_shipping_status": {
"not_shipped": 1,
"shipped": 1,
"in_transit": 1,
"out_for_delivery": 1,
"delivered": 1,
"delivery_failed": 1
},
"by_payment_status": {
"pending": 1,
"authorized": 1,
"paid": 1,
"captured": 1,
"failed": 1,
"refunded": 1,
"voided": 1
},
"total_revenue": 1,
"avg_order_value": 1,
"unique_customers": 1
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}