---
title: "Get Collections Timeslots"
method: GET
path: "/v4/collections/rm/timeslots/{shipmentId}"
tags: ["Collections"]
---

# Get Collections Timeslots

`GET /v4/collections/rm/timeslots/{shipmentId}`

## Request

- Base URL: `https://api.intersoftsapient.net`
- URL: `https://api.intersoftsapient.net/v4/collections/rm/timeslots/{shipmentId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://authentication.intersoftsapient.net/connect/token`

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

## Path parameters

- `shipmentId` string, required

## Response `200`

Returns a list of available dates for collection.

- GetCollectionsTimeslotsResponse: GetCollectionsTimeslots Response
  - `ShipmentId` string, nullable: The unique identifier of the shipment for which collection times have been requested.
  - `SlotReservationId` string, 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.
  - `SlotReservationExpiryTime` string, 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.
  - `Slots` Slot[], nullable: Contains a list of available dates for collection. Each entry in this list details potential collection dates that the customer can choose from based on the shipment and the carrier's schedule.
    - `SlotDate` string, nullable: 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.
    - `EstimatedWindow` string, nullable: An estimated time frame in which the collection is expected to occur on the specified **SlotDate**. This information is useful for customers to plan accordingly around the collection times.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `500`: Internal Server Error

---

[API](https://skmtc.dev/intersoftsapient/apis/royal-mail.md) - [All operations](https://skmtc.dev/intersoftsapient/apis/royal-mail/llms.txt) - [OpenAPI document](https://skmtc.dev/intersoftsapient/apis/royal-mail/revisions/acb747a1c3b6?raw)