List order ids by status

GET/client_api/v2/orders_by_status

The ids of your company's orders that have a shipment in the given status. Read each one with Get an order.

Query parameters

• statusstring

  A shipment status, such as in_transit. List order statuses has every value.

Returns

Returns a list of order ids.

Errors

• 401Unauthorized
  The token is missing, expired or invalid. Sign in again.

View as Markdown

GET /client_api/v2/orders_by_status

cURLJavaScriptPythonPHPC#Ruby

1curl -X GET "https://sandbox-api.vatit-stream.com/client_api/v2/orders_by_status?status=in_transit" \
2  -H "Authorization: Bearer $API_TOKEN"

Response200 OK401 Unauthorized

{
  "order_ids": [
    14
  ]
}