Developers
Deliveries12

List deliveries

GET/sales/deliveries

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

Authorization

AuthorizationBearer <token>

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

In: header

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "id"
  • "-id"
gateway?string

Only deliveries of the gateway with this public ID.

product_id?string

Only deliveries that grant access to the product with this public ID.

status?string

Only deliveries with this status.

Value in

  • "active"
  • "archived"
external_id?string

Only deliveries whose external_ids include this value.

q?string

Text search term.

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

application/json

curl -X GET "https://example.com/sales/deliveries"
{  "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"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Deliveries12

Deliveries in API v3: list deliveries, create a delivery, retrieve a delivery, update a delivery, duplicate a delivery, list delivery products, replace delivery products, list delivery release schedules, replace delivery release schedules, list delivery tags, replace delivery tags, apply delivery tags to existing users.

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.