## List delivery services

`GET /v1/delivery-services`

Find delivery services in the online store by specified conditions and choose records for further operations.

## Parameters

| Parameter | Type | Required | Description |
|-----------|------|:--------:|-------------|
| `filter` (query) | object \| string | no | Filter by [delivery service fields](/docs/entities/delivery-services/fields). Accepts a JSON object or bracket notation. [Filtering syntax](/docs/filtering). Example: `?filter[id]=85`. Operators: `$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`, `$in`, `$nin`, `$like`, `$nlike` |
| `sort` (query) | string | no | Comma-separated field names. A leading minus sorts in descending order. Example: `sort=-id` |
| `select` (query) | string | no | Comma-separated fields to return, or `*` for all fields. Example: `select=id,name,active,currency` |

The result contains all matching records, with no pagination. Only the parameters in the table are supported.

## Examples

### curl — personal key

```bash
curl -g "https://vibecode.bitrix24.com/v1/delivery-services?filter[id]=85&select=id,name,active,currency&sort=-id" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth app

```bash
curl -g "https://vibecode.bitrix24.com/v1/delivery-services?filter[id]=85&select=id,name,active,currency&sort=-id" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/delivery-services?filter[id]=85&select=id,name,active,currency&sort=-id', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(data)
```

### JavaScript — OAuth app

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/delivery-services?filter[id]=85&select=id,name,active,currency&sort=-id', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data, meta } = await res.json()
console.log(data)
```

## Response fields

| Field | Type | Description |
|-------|------|-------------|
| `success` | boolean | Always `true` on success |
| `data` | array | Delivery service records |
| `data[].id` | integer | Delivery service ID |
| `data[].parentId` | integer \| null | Parent service ID from the [delivery service list](/docs/entities/delivery-services/list). May be `null` |
| `data[].name` | string \| null | Delivery service name |
| `data[].active` | string \| null | Activity flag: `Y` or `N` |
| `data[].description` | string \| null | Delivery service description |
| `data[].currency` | string \| null | Currency code from the [currency list](/docs/entities/currencies/list) |
| `data[].sort` | integer \| null | Sort order |
| `data[].logotype` | integer \| null | Logo file ID, not a URL. May be `null` |
| `meta.total` | integer | Number of records in `data` |

## Response example

```json
{
  "success": true,
  "data": [
    {
      "id": 85,
      "name": "Courier delivery to an address",
      "active": "N",
      "currency": "USD"
    }
  ],
  "meta": {
    "total": 1
  }
}
```

## Error response example

400 — unsupported query parameter:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Only filter, sort and select are supported; the full list has no pagination"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|------|-------------|
| 400 | `INVALID_PARAMS` | Unsupported query parameter, repeated `sort` or `select`, invalid parameter type, or duplicate sort field |
| 400 | `INVALID_FILTER` | The request combines JSON and bracket filter notation, or repeats a filter condition |
| 400 | `INVALID_FILTER_SHAPE` | The filter has an invalid structure, empty conditions, nested values, or mixed array and operator forms |
| 400 | `INVALID_FILTER_OPERATOR` | Unsupported filter operator |
| 400 | `INVALID_DUPLICATE_FILTER_FIELD` | Multiple conditions produce the same filter field and operator |
| 400 | `UNKNOWN_FILTER_FIELD` | Unknown filter field |
| 400 | `UNKNOWN_SELECT_FIELD` | Unknown field in `select` |
| 400 | `UNKNOWN_SORT_FIELD` | Unknown field in `sort` |
| 502 | `BITRIX_RESPONSE_INVALID` | The response does not match the delivery service format |
| 422 | `BITRIX_ERROR` | Bitrix24 rejected the operation. The original error message is preserved |
| 403 | `BITRIX_ACCESS_DENIED` | Bitrix24 denied access |
| 403 | `SCOPE_DENIED` | The API key lacks the `delivery` scope |
| 401 | `TOKEN_MISSING` | No Bitrix24 credentials are configured for the key |

For common API errors, see [Errors](/docs/errors).

## See also

- [Get a delivery service](/docs/entities/delivery-services/get)
- [Create a delivery service](/docs/entities/delivery-services/create)
- [Update a delivery service](/docs/entities/delivery-services/update)
- [Delivery service fields](/docs/entities/delivery-services/fields)
- [Filtering syntax](/docs/filtering)
- [Delivery services](/docs/entities/delivery-services)