Skip to main content
Version: 202506

Get order count

GET 
/openapi/2025-06/orders/count

Provides the total number of orders matching the specified query parameters.

Request​

Query Parameters

    created_at_min string

    Filters orders created at or after the specified date and time. Format: YYYY-MM-DDTHH:mm:ssZ

    created_at_max string

    Filters orders created at or before the specified date and time. Format: YYYY-MM-DDTHH:mm:ssZ

    updated_at_min string

    Filters orders updated at or after the specified date and time. Format: YYYY-MM-DDTHH:mm:ssZ

    updated_at_max string

    Filters orders updated at or before the specified date and time. Format: YYYY-MM-DDTHH:mm:ssZ

    status string

    Filter by order status:

    • opened: pending payment
    • cancelled: cancelled
    • placed: in progress
    • finished: completed
    fulfillment_status string

    Filter by order fulfillment status:

    • initialled: initial
    • waiting: waiting to ship
    • partially_shipped: partially shipped
    • shipped: fully shipped
    • partially_finished: partially received
    • finished: fully received
    • cancelled: cancelled
    • returning: return in progress
    • partially_returned: partially returned
    • returned: fully returned
    financial_status string

    Filter by payment status:

    • waiting: pending payment
    • paying: payment under review
    • authorized: authorized
    • partially_paid: partially paid
    • paid: paid
    • cancelled: cancelled
    • failed: payment failed
    • refunding: refund in progress
    • refund_failed: refund failed
    • refunded: fully refunded
    • partially_refunded: partially refunded

Responses​

OK

Schema
    codestring

    error code

    messagestring

    error message

    data object
    countint32

    Count