# Courier options

Couriers you can name when you mark an order as shipping.

## Endpoints

-   [GET `/v1/print-farm/courier-options`](https://public-api.dapi.digital/docs/reference/print-farm-courier-options.md#listPrintFarmCourierOptions)

## The courier option object

### Attributes

-   `code` (string): Short courier code. Pass this value back when updating an order to `shipping`.
-   `name` (string): Human-readable courier name.

**The courier option object**

```json
null
```

## List available courier options

GET `/v1/print-farm/courier-options`

- **Credentials**: Any active API key.

- **For**: Print farms

- **Operation id**: `listPrintFarmCourierOptions`

Returns every available courier option (code + name) for use when updating an order to `shipping`. The list is the same for every caller. Always includes an `other` entry as a fallback for couriers not in the catalog.

### Returns 200 OK

The list of available courier options.

Response attributes (ListPrintFarmCourierOptionsResponseDto):

-   `courier_options` (array of PrintFarmCourierOptionResponseDto): All courier options available across configured ShipStation integrations.
    
    Described in [the courier option object](https://public-api.dapi.digital/docs/reference/print-farm-courier-options.md#farm_courier_option_object).
    

### Responses

-   `200`: The list of available courier options.
-   `401`: API key is missing or invalid.
-   `403`: The API key does not have the required permission scope.
-   `429`: Rate limit exceeded - wait until the window resets before retrying.
-   `500`: An unexpected error occurred on our side.

Errors use [the print farm error body](https://public-api.dapi.digital/docs/guides/print-farm-quickstart.md#errors).

**Request**

```bash
curl "https://public-api.dapi.digital/v1/print-farm/courier-options" \
  -H "x-api-key: $DAPI_API_KEY"
```

**Response 200**

```json
{
  "courier_options": [
    {
      "code": "ups",
      "name": "UPS"
    }
  ]
}
```

---

3DAPI API Docs. This page on the web: https://public-api.dapi.digital/docs/reference/print-farm-courier-options. Index of every page: https://public-api.dapi.digital/docs/llms.txt.
