Skip to main content
POST
/
collections
cURL
curl --request POST \
  --url https://api.atlast.co/v1/collections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "shipmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "bookingId": "<string>",
  "slot": {
    "date": "<string>"
  },
  "test": true,
  "sendEmail": false
}'
{
  "shipmentId": "<string>",
  "collectionState": "<string>",
  "failureReason": "<string>",
  "requestedTimeSlot": {
    "date": "<string>",
    "time": "<string>"
  },
  "collection": {
    "externalId": "<string>",
    "bookedTimeSlot": {
      "date": "<string>",
      "time": "<string>"
    },
    "rebooked": true
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Home collection details

​
shipmentId
string<uuid>
required

The id of the shipment created with the return or simple shipment endpoints.

​
bookingId
string

Specify the booking id if given by the shipment collection timeslot endpoint. Not mandatory as if needed the system will try to resolve it as part of the collection process. Used only for Royal Mail Home Collections

​
slot
object

The timeslot you would like to book this home collection. if not provided, system will try to book at earliest available time, that will usually be next day. Collection time slot

​
test
boolean

Set this flag to true if you're testing this endpoint, omitting or setting to false will make the system try to book a collection with the carrier. Depending on the carrier this might be difficult to cancel and it will automatically incur costs!

​
sendEmail
boolean
default:false

Send customer email communications flag. Setting this to true will make At Last send any collection related emails to the end user. This only impact collection creation emails when using the API. Email communication are conditional on the Carrier. This flag defaults to false.

Response

200 - application/json

The request has succeeded.

​
shipmentId
string
required
​
collectionState
string
required
​
collection
object
required

Home Collection finalised details

​
failureReason
string
​
requestedTimeSlot
object

Resovled collection time slot