B-b-cdn
Order

List orders by status

Changed on

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

Request

Query parameters

status'RECENT' | 'PENDING' | 'SETUP' | 'SHIPPED' | 'CANCELLED' | 'RETURNED' | 'TERMINATED' | 'SUSPENDED' | 'ERROR' | 'ALL' required

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

OK

successboolean

Changes

  • 76cfbed5eb40Revision changes
    • breaking

      the query request parameter status was restricted to a list of enum values

    • info

      added the new enum value ALL to the query request parameter status

    • info

      added the new enum value CANCELLED to the query request parameter status

    • info

      added the new enum value ERROR to the query request parameter status

    • info

      added the new enum value PENDING to the query request parameter status

    • info

      added the new enum value RECENT to the query request parameter status

    • info

      added the new enum value RETURNED to the query request parameter status

    • info

      added the new enum value SETUP to the query request parameter status

    • info

      added the new enum value SHIPPED to the query request parameter status

    • info

      added the new enum value SUSPENDED to the query request parameter status

    • info

      added the new enum value TERMINATED to the query request parameter status

    • info

      for the query request parameter status, the type was generalized from integer to string

  • 6b9208b64456Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status