Download OpenAPI specification:Download
Automate your Packfleet deliveries using our public API
Creates a collection
The collection has been successfully created.
{- "locationId": "string",
- "date": "2022-05-01",
- "earliestTime": "12:00",
- "latestTime": "14:00"
}
{- "collection": {
- "id": "string",
- "organizationId": "string",
- "date": "2022-01-02",
- "earliestTime": "10:30",
- "latestTime": "14:30",
- "location": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}
}
{- "collections": [
- {
- "id": "string",
- "organizationId": "string",
- "date": "2022-01-02",
- "earliestTime": "10:30",
- "latestTime": "14:30",
- "location": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}
]
}
{- "collection": {
- "id": "string",
- "organizationId": "string",
- "date": "2022-01-02",
- "earliestTime": "10:30",
- "latestTime": "14:30",
- "location": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}
}
Updates a collection
{- "locationId": "string",
- "date": "2022-05-01",
- "earliestTime": "12:00",
- "latestTime": "14:00"
}
{- "collection": {
- "id": "string",
- "organizationId": "string",
- "date": "2022-01-02",
- "earliestTime": "10:30",
- "latestTime": "14:30",
- "location": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}
}
Assign multiple shipments to the collection
{- "shipmentIds": "ship_clb19k5yl00006aul274377nx,ship_clb19k9j800006aul617id4nf"
}
{- "collection": {
- "id": "string",
- "organizationId": "string",
- "date": "2022-01-02",
- "earliestTime": "10:30",
- "latestTime": "14:30",
- "location": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}
}
Creates a collection location
The location has been successfully created.
{- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "postCode": "A12 3BC",
- "city": "London"
}, - "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00"
}
{- "collectionLocation": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}
}
{- "collectionLocations": [
- {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}
]
}
{- "collectionLocation": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}
}
Updates a collection location
{- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "postCode": "A12 3BC",
- "city": "London"
}
}
{ }
Creates multiple shipments
The records have been successfully created.
{- "collectionId": "string",
- "collectionLocationId": "string",
- "shipments": [
- {
- "brandId": "brand_cl9h2kivj0000c4ul15szftfx",
- "externalReference": "ORDER123",
- "delivery": {
- "notes": "string",
- "leaveInSafePlaceNotes": "string",
- "leaveWithNeighborNotes": "string",
- "earliestDate": "2022-05-01",
- "earliestTime": "12:00",
- "latestTime": "15:00",
- "confirmationCode": "1234",
- "recipientDetails": {
- "name": "string",
- "companyName": "string",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "postCode": "A12 3BC",
- "city": "London"
}, - "phone": "+441234567890",
- "email": "hello@example.com"
}
}, - "numberOfPacks": 1,
- "packs": [
- {
- "weight": 1,
- "dimensions": {
- "length": 1,
- "width": 1,
- "height": 1
}
}
], - "serviceType": "nextDay"
}
]
}
{- "shipments": [
- {
- "id": "string",
- "organizationId": "string",
- "brandId": "string",
- "trackingNumber": "beautiful-ship",
- "externalReference": "string",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z",
- "status": "SCHEDULED",
- "serviceType": "nextDay",
- "brand": {
- "id": "brand_cl8yhq9vm0000rful6wgz8jw5",
- "organizationId": "org_cl8yhq10a0000rful4xomfypk",
- "name": "string",
- "emoji": "string",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "collection": {
- "id": "string",
- "organizationId": "string",
- "date": "2022-01-02",
- "earliestTime": "10:30",
- "latestTime": "14:30",
- "location": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "collectionLocation": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "delivery": {
- "date": "2022-01-02",
- "notes": "string",
- "location": {
- "name": "string",
- "companyName": "string",
- "phone": "string",
- "email": "string",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "confirmationCode": "1234",
- "earliestTime": "12:00",
- "latestTime": "15:00",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "packs": [
- {
- "id": "string",
- "status": "SCHEDULED"
}
], - "proofsOfDelivery": [
- {
- "notes": "string",
- "status": "DELIVERED_TO_RECIPIENT",
- "coordinates": {
- "latitude": 51.512435,
- "longitude": -0.015243
}, - "imageUrls": [
- "string"
], - "createdAt": "2022-01-02T12:34:56.123Z"
}
]
}
]
}
{- "cursor": "string",
- "shipments": [
- {
- "id": "string",
- "organizationId": "string",
- "brandId": "string",
- "trackingNumber": "beautiful-ship",
- "externalReference": "string",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z",
- "status": "SCHEDULED",
- "serviceType": "nextDay",
- "brand": {
- "id": "brand_cl8yhq9vm0000rful6wgz8jw5",
- "organizationId": "org_cl8yhq10a0000rful4xomfypk",
- "name": "string",
- "emoji": "string",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "collection": {
- "id": "string",
- "organizationId": "string",
- "date": "2022-01-02",
- "earliestTime": "10:30",
- "latestTime": "14:30",
- "location": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "collectionLocation": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "delivery": {
- "date": "2022-01-02",
- "notes": "string",
- "location": {
- "name": "string",
- "companyName": "string",
- "phone": "string",
- "email": "string",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "confirmationCode": "1234",
- "earliestTime": "12:00",
- "latestTime": "15:00",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "packs": [
- {
- "id": "string",
- "status": "SCHEDULED"
}
], - "proofsOfDelivery": [
- {
- "notes": "string",
- "status": "DELIVERED_TO_RECIPIENT",
- "coordinates": {
- "latitude": 51.512435,
- "longitude": -0.015243
}, - "imageUrls": [
- "string"
], - "createdAt": "2022-01-02T12:34:56.123Z"
}
]
}
]
}
{- "shipment": {
- "id": "string",
- "organizationId": "string",
- "brandId": "string",
- "trackingNumber": "beautiful-ship",
- "externalReference": "string",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z",
- "status": "SCHEDULED",
- "serviceType": "nextDay",
- "brand": {
- "id": "brand_cl8yhq9vm0000rful6wgz8jw5",
- "organizationId": "org_cl8yhq10a0000rful4xomfypk",
- "name": "string",
- "emoji": "string",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "collection": {
- "id": "string",
- "organizationId": "string",
- "date": "2022-01-02",
- "earliestTime": "10:30",
- "latestTime": "14:30",
- "location": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "collectionLocation": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "delivery": {
- "date": "2022-01-02",
- "notes": "string",
- "location": {
- "name": "string",
- "companyName": "string",
- "phone": "string",
- "email": "string",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "confirmationCode": "1234",
- "earliestTime": "12:00",
- "latestTime": "15:00",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "packs": [
- {
- "id": "string",
- "status": "SCHEDULED"
}
], - "proofsOfDelivery": [
- {
- "notes": "string",
- "status": "DELIVERED_TO_RECIPIENT",
- "coordinates": {
- "latitude": 51.512435,
- "longitude": -0.015243
}, - "imageUrls": [
- "string"
], - "createdAt": "2022-01-02T12:34:56.123Z"
}
]
}
}
Updates a shipment
{- "brandId": "brand_cl9h2kivj0000c4ul15szftfx",
- "externalReference": "ORDER123",
- "numberOfPacks": 1,
- "packs": [
- {
- "weight": 1,
- "dimensions": {
- "length": 1,
- "width": 1,
- "height": 1
}
}
], - "serviceType": "nextDay",
- "delivery": {
- "notes": "string",
- "leaveInSafePlaceNotes": "string",
- "leaveWithNeighborNotes": "string",
- "earliestDate": "2022-05-01",
- "earliestTime": "12:00",
- "latestTime": "15:00",
- "confirmationCode": "1234",
- "recipientDetails": {
- "name": "string",
- "companyName": "string",
- "phone": "+441234567890",
- "email": "hello@example.com",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "postCode": "A12 3BC",
- "city": "London"
}
}
}, - "collectionId": "string",
- "collectionLocationId": "string"
}
{- "shipment": {
- "id": "string",
- "organizationId": "string",
- "brandId": "string",
- "trackingNumber": "beautiful-ship",
- "externalReference": "string",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z",
- "status": "SCHEDULED",
- "serviceType": "nextDay",
- "brand": {
- "id": "brand_cl8yhq9vm0000rful6wgz8jw5",
- "organizationId": "org_cl8yhq10a0000rful4xomfypk",
- "name": "string",
- "emoji": "string",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "collection": {
- "id": "string",
- "organizationId": "string",
- "date": "2022-01-02",
- "earliestTime": "10:30",
- "latestTime": "14:30",
- "location": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "collectionLocation": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "delivery": {
- "date": "2022-01-02",
- "notes": "string",
- "location": {
- "name": "string",
- "companyName": "string",
- "phone": "string",
- "email": "string",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "confirmationCode": "1234",
- "earliestTime": "12:00",
- "latestTime": "15:00",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "packs": [
- {
- "id": "string",
- "status": "SCHEDULED"
}
], - "proofsOfDelivery": [
- {
- "notes": "string",
- "status": "DELIVERED_TO_RECIPIENT",
- "coordinates": {
- "latitude": 51.512435,
- "longitude": -0.015243
}, - "imageUrls": [
- "string"
], - "createdAt": "2022-01-02T12:34:56.123Z"
}
]
}
}
Changes the delivery date of a shipment. This can be done at any point before the shipment is in a delivered state.
{- "deliveryDate": "2023-03-28"
}
{- "shipment": {
- "id": "string",
- "organizationId": "string",
- "brandId": "string",
- "trackingNumber": "beautiful-ship",
- "externalReference": "string",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z",
- "status": "SCHEDULED",
- "serviceType": "nextDay",
- "brand": {
- "id": "brand_cl8yhq9vm0000rful6wgz8jw5",
- "organizationId": "org_cl8yhq10a0000rful4xomfypk",
- "name": "string",
- "emoji": "string",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "collection": {
- "id": "string",
- "organizationId": "string",
- "date": "2022-01-02",
- "earliestTime": "10:30",
- "latestTime": "14:30",
- "location": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "collectionLocation": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "delivery": {
- "date": "2022-01-02",
- "notes": "string",
- "location": {
- "name": "string",
- "companyName": "string",
- "phone": "string",
- "email": "string",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "confirmationCode": "1234",
- "earliestTime": "12:00",
- "latestTime": "15:00",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "packs": [
- {
- "id": "string",
- "status": "SCHEDULED"
}
], - "proofsOfDelivery": [
- {
- "notes": "string",
- "status": "DELIVERED_TO_RECIPIENT",
- "coordinates": {
- "latitude": 51.512435,
- "longitude": -0.015243
}, - "imageUrls": [
- "string"
], - "createdAt": "2022-01-02T12:34:56.123Z"
}
]
}
}
Changes the delivery address of a shipment. This can be done at any point before the shipment is in a delivered state. Changing the address after weʼve collected your shipment may push the delivery date to the next available date.
{- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "postCode": "A12 3BC",
- "city": "London"
}
}
{- "shipment": {
- "id": "string",
- "organizationId": "string",
- "brandId": "string",
- "trackingNumber": "beautiful-ship",
- "externalReference": "string",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z",
- "status": "SCHEDULED",
- "serviceType": "nextDay",
- "brand": {
- "id": "brand_cl8yhq9vm0000rful6wgz8jw5",
- "organizationId": "org_cl8yhq10a0000rful4xomfypk",
- "name": "string",
- "emoji": "string",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "collection": {
- "id": "string",
- "organizationId": "string",
- "date": "2022-01-02",
- "earliestTime": "10:30",
- "latestTime": "14:30",
- "location": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "collectionLocation": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "delivery": {
- "date": "2022-01-02",
- "notes": "string",
- "location": {
- "name": "string",
- "companyName": "string",
- "phone": "string",
- "email": "string",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "confirmationCode": "1234",
- "earliestTime": "12:00",
- "latestTime": "15:00",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "packs": [
- {
- "id": "string",
- "status": "SCHEDULED"
}
], - "proofsOfDelivery": [
- {
- "notes": "string",
- "status": "DELIVERED_TO_RECIPIENT",
- "coordinates": {
- "latitude": 51.512435,
- "longitude": -0.015243
}, - "imageUrls": [
- "string"
], - "createdAt": "2022-01-02T12:34:56.123Z"
}
]
}
}
Generates a PDF of shipping labels for provided shipments
{- "shipmentIds": [
- "shipment_clhjjoidk000058ulamcw11l3"
], - "packIds": [
- "pack_clhjjor79000058ul9u1m3t18"
], - "labelSize": "rect"
}
{- "error": {
- "code": "internal-server-error",
- "message": "string",
- "status": 500,
- "context": {
- "<object_id>": "<Specific error message>"
}
}
}
{- "shipmentId": "string",
- "trackingNumber": "beautiful-ship",
- "status": "SCHEDULED",
- "deliveryDate": "2022-05-05",
- "sender": {
- "name": "string",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}
}, - "recipient": {
- "name": "string",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}
}, - "delivery": {
- "driverName": "string",
- "driverLocation": {
- "latitude": 51.512435,
- "longitude": -0.015243
}, - "stopNumber": 0,
- "driverAtStop": 0,
- "totalStops": 0,
- "timeWindowStart": "2022-05-01T12:34:56.789Z",
- "timeWindowEnd": "2022-05-01T12:34:56.789Z",
- "estimatedTime": "2022-05-01T12:34:56.789Z",
- "completedAt": "2022-05-01T12:34:56.789Z"
}, - "proofOfDelivery": {
- "notes": "string",
- "status": "DELIVERED_TO_RECIPIENT",
- "coordinates": {
- "latitude": 51.512435,
- "longitude": -0.015243
}, - "imageUrls": [
- "string"
], - "createdAt": "2022-01-02T12:34:56.123Z"
}, - "packs": [
- {
- "id": "string",
- "status": "SCHEDULED",
- "trackingHistory": [
- {
- "status": "SCHEDULED",
- "timestamp": "2022-05-01T12:34:56.789Z"
}
]
}
]
}
Gets tracking information about up to 50 shipments
{- "shipments": [
- {
- "shipmentId": "string",
- "trackingNumber": "beautiful-ship",
- "status": "SCHEDULED",
- "deliveryDate": "2022-05-05",
- "sender": {
- "name": "string",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}
}, - "recipient": {
- "name": "string",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}
}, - "delivery": {
- "driverName": "string",
- "driverLocation": {
- "latitude": 51.512435,
- "longitude": -0.015243
}, - "stopNumber": 0,
- "driverAtStop": 0,
- "totalStops": 0,
- "timeWindowStart": "2022-05-01T12:34:56.789Z",
- "timeWindowEnd": "2022-05-01T12:34:56.789Z",
- "estimatedTime": "2022-05-01T12:34:56.789Z",
- "completedAt": "2022-05-01T12:34:56.789Z"
}, - "proofOfDelivery": {
- "notes": "string",
- "status": "DELIVERED_TO_RECIPIENT",
- "coordinates": {
- "latitude": 51.512435,
- "longitude": -0.015243
}, - "imageUrls": [
- "string"
], - "createdAt": "2022-01-02T12:34:56.123Z"
}, - "packs": [
- {
- "id": "string",
- "status": "SCHEDULED",
- "trackingHistory": [
- {
- "status": "SCHEDULED",
- "timestamp": "2022-05-01T12:34:56.789Z"
}
]
}
]
}
]
}
{- "collectionId": "string",
- "status": "SCHEDULED",
- "date": "2022-01-02",
- "location": {
- "name": "string",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}
}, - "collection": {
- "driverName": "string",
- "driverLocation": {
- "latitude": 51.512435,
- "longitude": -0.015243
}, - "stopNumber": 0,
- "driverAtStop": 0,
- "totalStops": 0,
- "timeWindowStart": "2022-05-01T12:34:56.789Z",
- "timeWindowEnd": "2022-05-01T12:34:56.789Z",
- "estimatedTime": "2022-05-01T12:34:56.789Z",
- "completedAt": "2022-05-01T12:34:56.789Z"
}, - "proofOfCollection": {
- "notes": "string",
- "status": "COLLECTED",
- "coordinates": {
- "latitude": 51.512435,
- "longitude": -0.015243
}, - "imageUrls": [
- "string"
], - "createdAt": "2022-01-02T12:34:56.123Z"
}
}
Webhooks can be used to receive notifications to objects such as Shipments and Collections whenever they change. Once you have registered a webhook you will start receiving POST requests to the configured endpoint which can be used to trigger business logic instead of relying on polling the API periodically.
The webhook has been successfully created.
{- "topic": "shipment.created",
- "version": "V1"
}
{- "webhook": {
- "id": "webhook_cl8yhq9vm0000rful6wgz8jw5",
- "organizationId": "org_cl8yhq10a0000rful4xomfypk",
- "status": "ENABLED",
- "topic": "shipment.created",
- "version": "V1",
- "lastSuccessfulRequest": "2022-01-02T12:34:56.123Z",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "secret": "18A1E3894B3B9549EF5B18A4764ED7B888B15474411855BE424518C68FB4EC87"
}
{- "id": "string",
- "organizationId": "string",
- "brandId": "string",
- "trackingNumber": "beautiful-ship",
- "externalReference": "string",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z",
- "status": "SCHEDULED",
- "serviceType": "nextDay",
- "brand": {
- "id": "brand_cl8yhq9vm0000rful6wgz8jw5",
- "organizationId": "org_cl8yhq10a0000rful4xomfypk",
- "name": "string",
- "emoji": "string",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "collection": {
- "id": "string",
- "organizationId": "string",
- "date": "2022-01-02",
- "earliestTime": "10:30",
- "latestTime": "14:30",
- "location": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "collectionLocation": {
- "id": "string",
- "organizationId": "string",
- "name": "Warehouse",
- "phone": "+447912345678",
- "defaultCollectionEarliestTime": "12:00",
- "defaultCollectionLatestTime": "15:00",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "delivery": {
- "date": "2022-01-02",
- "notes": "string",
- "location": {
- "name": "string",
- "companyName": "string",
- "phone": "string",
- "email": "string",
- "address": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "city": "London",
- "countryCode": "GB",
- "postCode": "A12 3BC",
- "latitude": "51.516243",
- "longitude": "-0.015327"
}, - "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "confirmationCode": "1234",
- "earliestTime": "12:00",
- "latestTime": "15:00",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}, - "packs": [
- {
- "id": "string",
- "status": "SCHEDULED"
}
], - "proofsOfDelivery": [
- {
- "notes": "string",
- "status": "DELIVERED_TO_RECIPIENT",
- "coordinates": {
- "latitude": 51.512435,
- "longitude": -0.015243
}, - "imageUrls": [
- "string"
], - "createdAt": "2022-01-02T12:34:56.123Z"
}
]
}
{- "webhooks": [
- {
- "id": "webhook_cl8yhq9vm0000rful6wgz8jw5",
- "organizationId": "org_cl8yhq10a0000rful4xomfypk",
- "status": "ENABLED",
- "topic": "shipment.created",
- "version": "V1",
- "lastSuccessfulRequest": "2022-01-02T12:34:56.123Z",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}
]
}
{- "webhook": {
- "id": "webhook_cl8yhq9vm0000rful6wgz8jw5",
- "organizationId": "org_cl8yhq10a0000rful4xomfypk",
- "status": "ENABLED",
- "topic": "shipment.created",
- "version": "V1",
- "lastSuccessfulRequest": "2022-01-02T12:34:56.123Z",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}
}
Create a new brand which can be used to override the details of a shipments sender. This can be used to ship packages on behalf of another merchant
The brand has been successfully created.
{- "name": "string",
- "emoji": "string"
}
{- "brand": {
- "id": "brand_cl8yhq9vm0000rful6wgz8jw5",
- "organizationId": "org_cl8yhq10a0000rful4xomfypk",
- "name": "string",
- "emoji": "string",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}
}
{- "brands": [
- {
- "id": "brand_cl8yhq9vm0000rful6wgz8jw5",
- "organizationId": "org_cl8yhq10a0000rful4xomfypk",
- "name": "string",
- "emoji": "string",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}
]
}
{- "brand": {
- "id": "brand_cl8yhq9vm0000rful6wgz8jw5",
- "organizationId": "org_cl8yhq10a0000rful4xomfypk",
- "name": "string",
- "emoji": "string",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}
}
Updates the details of an already created brand
The brand has been successfully updated.
{- "name": "string",
- "emoji": "string"
}
{- "brand": {
- "id": "brand_cl8yhq9vm0000rful6wgz8jw5",
- "organizationId": "org_cl8yhq10a0000rful4xomfypk",
- "name": "string",
- "emoji": "string",
- "createdAt": "2022-01-02T12:34:56.123Z",
- "updatedAt": "2022-01-02T12:34:56.123Z"
}
}
Fetch the available rates to deliver the requested packs
{- "numberOfPacks": 1,
- "packs": [
- {
- "weight": 1,
- "dimensions": {
- "length": 1,
- "width": 1,
- "height": 1
}
}
], - "collectionDate": "2022-05-01",
- "earliestTime": "12:00",
- "latestTime": "15:00",
- "originAddress": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "postCode": "A12 3BC",
- "city": "London"
}, - "destinationAddress": {
- "line1": "53 Kingsborough Road",
- "line2": "string",
- "line3": "string",
- "postCode": "A12 3BC",
- "city": "London"
}
}
{- "rates": [
- {
- "serviceType": "nextDay",
- "amount": {
- "amount": 0,
- "currency": "GBP"
}, - "earliest_collection_time": "2022-01-02T12:34:56.123Z",
- "earliest_delivery_time": "2022-01-02T12:34:56.123Z"
}
]
}
Changes the status of a shipment to help with testing.
When using this API and setting the shipment status to "OUT_FOR_DELIVERY", the tracking API returns "simulated" live tracking information for the shipment. If the status is set to "DELIVERED", a simulated proof of delivery is also available.
Status changed successfully
{- "status": "SCHEDULED"
}
{ }