Order

List orders by status

Use this BillingServ API endpoint to list orders by status. Review the response for the operation result or validation errors.

get/order/get-orders-by-status

Query parameters

Status key from GET /api/v2/order/statuses, or ALL.

Use a status_key from GET /api/v2/order/statuses, or ALL to return every order.

per_pageinteger

Response

successboolean

Changes

Changed in 2 of the 6 revisions of this API.117

Aug 22, 202676cfbed5eb40111See the full diff
- ▲
  the query request parameter status was restricted to a list of enum values
  request-parameter-became-enum
- ○
  added the new enum value ALL to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value CANCELLED to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value ERROR to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value PENDING to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value RECENT to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value RETURNED to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value SETUP to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value SHIPPED to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value SUSPENDED to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value TERMINATED to the query request parameter status
  request-parameter-enum-value-added
- ○
  for the query request parameter status, the type was generalized from integer to string
  request-parameter-type-generalized
Aug 22, 20266b9208b644566See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added

Full history