# List purposes of shipment

`GET /client_api/v2/purpose_of_shipments`

The incoterms your company may quote with. A quote's and an order's `purpose_of_shipment_id` comes from here.

## Returns

Returns a list of purpose of shipments.

- `purpose_of_shipments` (array of objects, required): The purposes of shipment on this page.
  - `id` (integer, required): The purpose's id, for a quote's or order's `purpose_of_shipment_id`.
  - `code` (string, required): The incoterm's code, such as `DDP` or `DAP`.
  - `description` (string, required): The incoterm's name.
  - `explanation` (object, nullable, required): What the incoterm means for who pays what. Often empty.
- `meta` (object, required): How many pages and records the list has.
  - `page_count` (integer, required): How many pages the list has. Ask for another with `?page=`.
  - `record_count` (integer, required): How many records the list has across all pages.

## 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/purpose_of_shipments" \
  -H "Authorization: Bearer $API_TOKEN"
```

## Example response (200)

```json
{
  "purpose_of_shipments": [
    {
      "id": 22,
      "code": "SALE",
      "description": "Sale of goods",
      "explanation": null
    }
  ],
  "meta": {
    "page_count": 1,
    "record_count": 1
  }
}
```