Skip to main content
PUT
/
collections
/
cancel
cURL
curl --request PUT \
  --url https://api.atlast.co/v1/collections/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shipmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.atlast.co/llms.txt

Use this file to discover all available pages before exploring further.

Royal Mail collections can be cancelled using this endpoint. Do not attempt to cancel collections that are just about to happen or have already been collected. Such calls will likely fail.
This endpoint is only available for Royal Mail collections.

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 Currently only works for Royal Mail Collections.

​
shipmentId
string<uuid>
required

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

Response

200

The request has succeeded.