Book Collection

post

https://api.intersoftsapient.net/v4/collections/rm/{shipmentId}

Books a Royal Mail collection request for an existing shipment. The service used to create the shipment must allow for the shipment to be collected. If no timeslot is sent in the request, then the first available collection date will be automatically selected.

Path Params

shipmentId

string

required

The Shipment Id may be an id or a tracking/barcode number.

Body Params

Create Collection Request

SlotReservationId

string | null

The SlotReservationId returned in the Get Collection Timeslots response

SlotDate

date | null

The collection date selected from the available slots in the Get Collection Timeslots response

BringMyLabel

boolean

required

If true, Royal Mail will bring the Label and Custom Declaration if required.
Defaults to false

OptOutFromRmNotifications

boolean

Indicates whether the Royal Mail collection notifications are sent to the consignee or not.

The accepted values are the following:

true — Royal Mail will not send the collection notifications to the consignee, allowing customers to send their own branded notifications instead.
false — Royal Mail will send the collection notifications to the consignee.

Note: By default, this field is set to false.

CollectionSafePlace

string | null

Provides details about a designated safe place location where Royal Mail can securely collect the parcel—for example, behind the bin or in the porch. This ensures that the collection can proceed smoothly if the primary location is inaccessible or no one is home.

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

200Returns the collection date and its unique identifier.