PRproject44
Capacity

Get capacity information

Retrieve capacity information for a specific site and date

get/services/appointments/v1/capacity

Request

Query parameters

siteCodestring required

Site code to get capacity for

capacityDatestring date required

Date for capacity information (YYYY-MM-DD format)

Response

Capacity information retrieved successfully

capacityDatestring date

Date for the capacity information

siteCodestring

Code identifying the site

totalSlotsinteger

Total number of slots available for the date

totalBookedSlotsinteger

Total number of booked slots for the date

totalCapacityinteger

Total available capacity (totalSlots - bookedSlots - unplannedShipments)

unplannedShipmentsCountinteger

Number of unplanned shipments for the date

Example response

{
  "availableSlots": [
    {
      "endDateTime": "2024-01-15T12:00:00-05:00",
      "section": "DOCK001",
      "startDateTime": "2024-01-15T10:00:00-05:00"
    }
  ],
  "bookedSlots": [
    {
      "endDateTime": "2024-01-15T11:00:00-05:00",
      "shipmentNumber": "SHIP123456",
      "startDateTime": "2024-01-15T09:00:00-05:00"
    }
  ],
  "capacityDate": "2024-01-15",
  "siteCode": "SITE001",
  "totalSlots": 20,
  "totalBookedSlots": 8,
  "totalCapacity": 10,
  "unplannedShipmentsCount": 2
}

Changes

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