# List deliveries

`GET https://api.cademi.com.br/api/v3/sales/deliveries`

Operation ID: `deliveries.list` · API v3

Credentials restricted to specific products only see deliveries whose products are all within the scope of the current credentials.

Required permissions: `deliveries.read`.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `limit` | query | integer | no |  |
| `cursor` | query | string | no |  |
| `sort` | query | string, one of `id`, `-id` | no |  |
| `gateway` | query | string | no |  |
| `product_id` | query | string | no |  |
| `status` | query | string, one of `active`, `archived` | no |  |
| `external_id` | query | string | no |  |
| `q` | query | string | no |  |

## Responses

### 200

Returns the collection of deliveries.

Body: `data`: array of Delivery.

Fields of Delivery:

| Field | Type | Required | Description |
|---|---|---|---|
| `created_at` | string (date-time) | yes |  |
| `enrollments_count` | integer | yes |  |
| `external_ids` | array of string | yes | Product codes on the payment gateway. Existing codes are never rewritten, because cancellations are matched to the delivery by these codes. |
| `gateway` | string | yes | Public ID of the payment gateway from the catalog, prefixed with gtw_. |
| `hidden` | boolean | yes |  |
| `id` | string | yes | Public ID of the delivery, prefixed with dlv_. |
| `kind` | string, one of `one_time`, `subscription` | yes |  |
| `name` | string | yes |  |
| `object` | string, one of `delivery` | yes |  |
| `postback_url` | string | yes | URL that the payment gateway calls when a sale occurs. |
| `products_count` | integer | yes |  |
| `revision` | string | yes |  |
| `secret` | object | yes | The gateway secret is write-only. Responses only indicate whether it is configured. |
| `status` | string, one of `active`, `archived` | yes | Lifecycle status of the delivery. Archiving a delivery stops new sales through it; users who already purchased keep their access. |
| `tags_count` | integer | yes |  |
| `updated_at` | string (date-time) | yes |  |

### 400

The cursor is invalid or the request contains an unsupported query parameter.

Body: Error.

### 401

The credential is missing, malformed, expired, or revoked.

Body: Error.

### 403

The current credentials do not have the permission required by this operation.

Body: Error.

### 422

The request body or query parameters failed validation.

Body: ValidationFailed.

Full schema: https://cademi.dev/openapi/v3.json