Developers
Deliveries2

List deliveries of a gateway

GET/third/delivery

Lists the deliveries of a gateway and sale type, with the school domain and the postback URL to configure at the gateway.

Authorization

apiKey
AuthorizationBearer <token>

The school API key, found in the dashboard settings, sent in the Authorization header. The Bearer prefix is optional.

In: header

Query Parameters

provider*string

Gateway key.

type*string

single for one-time sales; any other value means subscriptions.

Value in

  • "single"
  • "recurrence"
teste?string

Connection check: any true value returns data.data = teste and ignores the other parameters.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/third/delivery?provider=string&type=single"
{  "code": 200,  "message": "string",  "profiler": [],  "success": true,  "version": 2,  "data": {    "deliveries": [      {        "config_url": "http://example.com",        "external_ids": [          "string"        ],        "id": 0,        "name": "string",        "type": "single"      }    ],    "domain": "string",    "webhook_url": "http://example.com"  }}

Deliveries2

Deliveries: what a sale grants, per gateway product.

Create or extend a delivery POST

Makes sure a delivery of the gateway listens to the given product IDs. When a delivery already has one of the IDs, the missing ones are added to it (its name and type do not change). When none has them, a new delivery is created. An ID that belongs to a different delivery is refused. The delivery is nested twice: `data.data`.