Developers
Deliveries12

Retrieve a delivery

GET/sales/deliveries/{delivery_id}

Archived deliveries can still be retrieved, which allows them to be restored through the update operation.

The response includes an ETag representing the current revision. Send this value in the If-Match header when modifying the delivery to avoid overwriting a newer version.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

delivery_id*string

Public ID of the delivery, prefixed with dlv_.

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sales/deliveries/string"
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "enrollments_count": 0,    "external_ids": [      "string"    ],    "gateway": "string",    "hidden": true,    "id": "string",    "kind": "one_time",    "name": "string",    "object": "delivery",    "postback_url": "string",    "products_count": 0,    "revision": "string",    "secret": {      "configured": true    },    "status": "active",    "tags_count": 0,    "updated_at": "2019-08-24T14:15:22Z"  }}

Create a delivery POST

Creates a delivery for a payment gateway from the gateway catalog. The selected gateway determines whether a secret is required. The secret is write-only: responses indicate only whether a secret is configured.

Update a delivery PATCH

Updates an existing delivery. Changing `status` requires the `deliveries.archive` permission in addition to `deliveries.update`. Archiving a delivery stops it from processing new sales but does not revoke access from users who have already purchased. To avoid overwriting a newer version, send the delivery's current `ETag` in the `If-Match` header. Replicated deliveries are read-only; updating or archiving them returns `403` with the `replica_readonly` error code.