Sign in

v1

latestOpenAPI 3.1.02026-07-14323.2 KB

List order statuses

Retrieves a list of order statuses with pagination.

get/order-statuses

Query parameters

countinteger

The maximum number of results to be returned.

offsetinteger

The starting position for the returned values.

fieldsstring

Comma-separated list of fields to include in the response.

Response

A list of order statuses.

idinteger

The ID of the order status.

namestring

The name of the order status.

type'paid' | 'unpaid' | 'cancelled' | 'shipped' | 'pre-order' | 'custom'

The type of order status, corresponding to the order status' assignment to ShopWired's default order status.

sortOrderinteger

The position of the order status in the sort order.

All 3 operations