Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Collections

Book Collection

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. <br /> <br />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.

post/v4/collections/rm/{shipmentId}

Path parameters

shipmentIdstring 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.

Request body

SlotReservationIdstring nullable

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.

SlotDatestring date nullable

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.

BringMyLabelboolean 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. <br /> <br />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.

OptOutFromRmNotificationsboolean

Indicates whether the Royal Mail collection notifications are sent to the consignee or not. <br /> <br />The accepted values are the following: <br /><ul><li>true — Royal Mail will not send the collection notifications to the consignee, allowing customers to send their own branded notifications instead.</li><li>false — Royal Mail will send the collection notifications to the consignee.</li></ul> <br />Note: By default, this field is set to false.

CollectionSafePlacestring nullable

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.

Example request

{
  "SlotReservationId": "99887654",
  "SlotDate": "2023-10-31"
}

Response

Returns the collection date and its unique identifier.

CollectionOrderIdstring nullable

A unique identifier assigned to the collection order. This ID can be used for tracking and managing the collection, providing a reference point for any inquiries or follow-ups related to the scheduled collection.

CollectionDatestring date-time

The specific date on which the collection has been booked. This date confirms the arrangement made by the customer for the designated collection of their shipment.

Example response

{
  "CollectionOrderId": "CC-W307-028741033",
  "CollectionDate": "2023-07-04"
}