# List order statuses

`GET /client_api/v2/order_statuses`

Every status an order or shipment can have.

## Returns

Returns a list.

- `id` (enum, required): The status, as it appears on an order or shipment. Possible enum values: `incomplete`, `order_received`, `awaiting_additional_documentation`, `awaiting_prepayment`, `awaiting_waybill_generation`, `awaiting_schedule_pickup`, `awaiting_pickup`, `awaiting_swap_out`, `pickup_missed`, `in_transit`, `partially_delivered`, `delivered`, `invoice_to_be_paid`, `invoice_paid`, `cancelled`, `lost_in_transit`, `awaiting_consolidation`, `consolidated`.
- `description` (string, required): The status in words.
- `value` (enum, required): The same as `id`. Possible enum values: `incomplete`, `order_received`, `awaiting_additional_documentation`, `awaiting_prepayment`, `awaiting_waybill_generation`, `awaiting_schedule_pickup`, `awaiting_pickup`, `awaiting_swap_out`, `pickup_missed`, `in_transit`, `partially_delivered`, `delivered`, `invoice_to_be_paid`, `invoice_paid`, `cancelled`, `lost_in_transit`, `awaiting_consolidation`, `consolidated`.

## Errors

- `401 Unauthorized`: The token is missing, expired or invalid. Sign in again.

## Example request (curl)

```bash
curl -X GET "https://sandbox-api.vatit-stream.com/client_api/v2/order_statuses" \
  -H "Authorization: Bearer $API_TOKEN"
```

## Example response (200)

```json
[
  {
    "id": "incomplete",
    "description": "Incomplete",
    "value": "incomplete"
  },
  {
    "id": "order_received",
    "description": "Order received",
    "value": "order_received"
  },
  {
    "id": "awaiting_additional_documentation",
    "description": "Awaiting additional documentation",
    "value": "awaiting_additional_documentation"
  },
  {
    "id": "awaiting_prepayment",
    "description": "Awaiting prepayment",
    "value": "awaiting_prepayment"
  },
  {
    "id": "awaiting_waybill_generation",
    "description": "Awaiting waybill generation",
    "value": "awaiting_waybill_generation"
  },
  {
    "id": "awaiting_schedule_pickup",
    "description": "Awaiting schedule pickup",
    "value": "awaiting_schedule_pickup"
  },
  {
    "id": "awaiting_pickup",
    "description": "Awaiting pickup",
    "value": "awaiting_pickup"
  },
  {
    "id": "awaiting_swap_out",
    "description": "Awaiting swap out",
    "value": "awaiting_swap_out"
  },
  {
    "id": "pickup_missed",
    "description": "Pickup missed",
    "value": "pickup_missed"
  },
  {
    "id": "in_transit",
    "description": "In transit",
    "value": "in_transit"
  },
  {
    "id": "partially_delivered",
    "description": "Partially delivered",
    "value": "partially_delivered"
  },
  {
    "id": "delivered",
    "description": "Delivered",
    "value": "delivered"
  },
  {
    "id": "invoice_to_be_paid",
    "description": "Invoice to be paid",
    "value": "invoice_to_be_paid"
  },
  {
    "id": "invoice_paid",
    "description": "Invoice paid",
    "value": "invoice_paid"
  },
  {
    "id": "cancelled",
    "description": "Cancelled",
    "value": "cancelled"
  },
  {
    "id": "lost_in_transit",
    "description": "Lost in transit",
    "value": "lost_in_transit"
  },
  {
    "id": "awaiting_consolidation",
    "description": "Awaiting consolidation",
    "value": "awaiting_consolidation"
  },
  {
    "id": "consolidated",
    "description": "Consolidated",
    "value": "consolidated"
  }
]
```