v1

latestOpenAPI 3.0.12026-07-242073551.1 MB

Collections

Get Collections Timeslots

Retrieve all available time slots for shipment collection based on a shipment tracking number or uniqueId. This endpoint is essential for customers who wish to schedule a collection and need to know which dates and times are available for their specific shipment. <br /> <br />Note: Before using this endpoint, make sure your shipment has been created using Royal Mail.

get/v4/collections/rm/timeslots/{shipmentId}

Path parameters

shipmentIdstring required

A unique identifier (shipmentId) or tracking number returned in the Create shipment response. This ID is used to reference and track specific shipments within the system.

Response

Returns a list of available dates for collection.

ShipmentIdstring nullable

The unique identifier of the shipment for which collection times have been requested.

SlotReservationIdstring nullable

A unique identifier which is used to reserve a specific timeslot for the collection. This ID is essential for booking a collection at a later stage and tracking the reserved slot.

SlotReservationExpiryTimestring date-time

The deadline by which the reserved slot must be confirmed or used. This timestamp ensures that customers are aware of the time limit for claiming their reserved collection slot.

Example response

{
  "ShipmentId": "c4e60776-288f-464e-b35b-ff0f3252c0f0",
  "SlotReservationId": "CC-W307-028741033",
  "SlotReservationExpiryTime": "2023-11-05T14:30:00Z",
  "Slots": [
    {
      "SlotDate": "2023-11-05",
      "EstimatedWindow": "14:30-16:30"
    }
  ]
}