GET method to display all the information on a specific delivery.
With this call you can get the features of the delivery,
price, date of creation, shipping status, type of delivery, if the delivery is in a campaign or if it also belongs to an app. You have to provide the secret of the account as a header
Name | Description |
---|---|
account_id required | Your account unique identifier to access the API. This parameter is part of the authorization process |
delivery_id required | Unique identifier of the Delivery you want to get all the information. This parameter have to replace: delivery_id in the example of the call. |
app_id | Filter by app_id |
campaign_id | Filter by campaign_id |
channel | Filter by channel |
status | Filter by status |
refunded | Filter by refunded |
contact_id | Filter by contact_id |
device_id | Filter by device_id |
created_since | Created since inclusive |
created_until | Created until inclusive |
updated_since | Updated since inclusive |
updated_until | Updated until inclusive |
limit | Max number of deliveries returned, default max set to 200 |
from_id | Query deliveries after this delivery |
until_id | Query deliveries before this delivery |
order | Creation DESC or ASC order |
GET
/v2/account/:account_id/deliveries
Accept: application/json
Authorization: Token token={account.secret}
200
{
"deliveries": [
{
"delivery": {
"id": "54f97ac2a09673c4b5000001",
"created_at": "2015-03-06T10:00:34Z",
"updated_at": "2015-03-06T10:00:42Z",
"channel": "EMAIL",
"status": "sent",
"refunded": false,
"template_data": {
"sender": "John",
"subject": "Hey Jane!",
"content": "Hey Jane! This is a test"
},
"channel_data": {
"3": "janedoe@example.com"
},
"price": {
"amount": 0.01,
"currency": "€"
}
}
},
{
"delivery": {
"id": "54f97ac3a09673c4b5000003",
"created_at": "2015-03-06T10:00:35Z",
"updated_at": "2015-03-06T10:00:44Z",
"channel": "EMAIL",
"status": "sent",
"refunded": false,
"template_data": {
"sender": "John",
"subject": "Hey Jane!",
"content": "Hey Jane! This is a test"
},
"channel_data": {
"3": "janedoe@example.com"
},
"price": {
"amount": 0.01,
"currency": "€"
}
}
}
]
}