Book Collection

post

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

Schedule a collection of your shipments from a specified location. This endpoint is particularly useful for customers who need to return the parcel and prefer the convenience of having Royal Mail collect the items directly from their address rather than dropping them off at a postal center.

Note: The service used to create the shipment must allow for the shipment to be collected. If no timeslot is sent in the request, then by default, the first available collection date will be selected.

Path Params

shipmentId

string

required

A unique identifier (shipmentId) or tracking number returned in the Create shipment response. This ID is used to specify the shipment that is being collected.

Body Params

Create Collection Request

SlotReservationId

string | null

The identifier returned from the Get Collection Timeslots API response. This ID corresponds to the selected time slot for the collection, ensuring that the booking is tied to the correct collection slot previously reserved by the customer.

SlotDate

date | null

The collection date chosen from the list of available slots provided in the Get Collection Timeslots API response. This date indicates when the collection from the specified address will take place.

BringMyLabel

boolean

required

A boolean parameter that indicates whether Royal Mail should bring the shipping label and any required customs declaration documents when they come to collect the shipment.

Note: By default, this field is set to false. If set to true, Royal Mail will provide the necessary documentation for the shipment during the collection.

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

200Returns the collection date and its unique identifier.