get
https://{subdomain}.myshoplaza.com/openapi/2025-06/orders/count
Provides the total number of orders matching the specified query parameters.
Requiresread_orderaccess scope. More access scope
The Get Order Count API retrieves detailed information about a specific order based on its unique ID.
This API is especially useful for:
- Viewing complete order information including line items and fulfillment status.
- Accessing customer and payment details associated with an order.
- Checking order financial and fulfillment status for processing.
Request Parameters
Public Request Parameters
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
created_at_min | string | No | Start of creation date range (ISO 8601) | "2025-06-01T00:00:00Z" |
created_at_max | string | No | End of creation date range (ISO 8601) | "2025-06-30T23:59:59Z" |
updated_at_min | string | No | Start of update date range (ISO 8601) | "2025-06-15T00:00:00Z" |
updated_at_max | string | No | End of update date range (ISO 8601) | "2025-06-15T23:59:59Z" |
status | string | No | Order lifecycle status | "finished" |
fulfillment_status | string | No | Filters orders by their financial status. Possible values: waiting (awaiting payment), paying (in progress), paid (completed), cancelled (canceled), failed (payment failed), refunding (refund in progress), refund_failed (refund failed), refunded (completed), partially_refunded (partial refund issued). paid | "shipped" |
financial_status | string | No | Filters orders by their fulfillment status. Possible values: initialled (initialized), waiting (awaiting fulfillment), partially_shipped (partially shipped), shipped (fully shipped), partially_finished (partially completed), finished (fully completed), cancelled (canceled), returning (in return process), returned (fully returned), partially_returned (partially returned). | "paid" |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "success" | Status code of the API response |
message | string | "Order retrieved successfully" | Descriptive message about the response |
data.count | int32 | - | Complete order object containing all details |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |