PRproject44
Slots

Get available slots for shipment

Retrieve available time slots for a shipment

post/services/appointments/v1/slots

Request

Request body

Example request

{
  "appointmentWindow": {
    "start_date_time": "2024-01-15T00:00:00Z",
    "end_date_time": "2024-01-20T23:59:59Z"
  },
  "identifiers": {
    "shipmentReference": "SHIP123456",
    "siteCode": "SITE001",
    "stopSequenceNumber": 1
  }
}

Response

Available slots retrieved successfully

statusstring

Status of the operation

Example response

{
  "results": [
    {
      "shipmentReference": "SHIP123456",
      "siteCode": "SITE001",
      "stopReferenceNumber": 1,
      "slots": [
        {
          "endDateTime": "2024-01-15T12:00:00-05:00",
          "startDateTime": "2024-01-15T10:00:00-05:00"
        }
      ]
    }
  ],
  "status": "SUCCESS"
}

Changes

No recorded changes to this operation across all 1 revision of this API.