API Collection

Complexity

Estimated release
(functioning API)

Description

SameDay A to B

Easy

Available to Use

The SameDay A to B API collection is an 'easy to integrate' set of APIs designed for point-to-point deliveries.

The services allow you to get a price using the quote API or place a booking using the bookings API.

This API also allows for wait and returns to be booked by simply setting a flag to true.

SameDay Multistop

Easy

Available to Use

An API collection designed to handle multi-stop bookings.

This functionality is intended for customers who require support for jobs involving multiple drop-off locations and /or pick-up locations.

The term "stop" is used generically to refer to both collection and delivery points.

Cancel and Update APIs

Easy

Available to Use

The cancel API permits you to cancel a booking up to the point that it is collected.

SameDay A to B Manifested

Medium

Available to Use

The SameDay Manifested A to B API is a user-friendly suite of APIs crafted for seamless integration, specifically tailored for point-to-point deliveries.

Within this set of services, you can obtain pricing information through the quote API or initiate a booking using the bookings API.

Additionally, this API empowers you to supply specific details such as item barcodes that a couriers can scan, as well as item description thereby enabling parcel-level tracking.

Furthermore, this API offers indemnity support, allowing you to assign a value to your goods for added protection. For more detailed information on indemnity, please refer to the CitySprint Terms and Conditions.

SameDay Multistop Manifested

Medium

Available to Use

This API is specifically designed to manage multi-stop bookings.

This feature is intended to cater to customers who require assistance with jobs that involve multiple drop-off and/or pick-up locations.

Within this API, you have the flexibility to provide details such as barcodes & descriptions of all items in the booking enabling a courier to scan items along the route and in turn enabling you to track parcels at a granular level.

You can also allocate specific parcel or barcodes to specific stops, which enables a courier to scan them correctly upon pickup and delivery at the designated locations.

Additionally, this API includes indemnity support, allowing you to assign a value to your goods for added protection. For more comprehensive information on indemnity, please refer to the CitySprint Terms and Conditions.

The term "stop" is used generically to refer to both collection and delivery points.

Booking Information APIs

Medium

Available to Use

The booking information API provides the capability to fetch bookings.

You can do this either by specifying the job number for a single booking or by using various parameters to retrieve multiple bookings in a list.

You have the flexibility to choose between a summary view and a detailed view by adjusting the "detailed" parameter as needed.

Status webhook

Easy

Available to Use

The status webhook automatically transmits data from our backend system to a designated endpoint that you've specified.

This feature provides you with nearly real-time updates and information about the status of your collections and deliveries.

Retrieve tracking information

Medium

End November 2023

Part of the booking information collection - This API enables you to fetch all the status updates related to a booking.

These updates are presented in an array, ordered chronologically, with the most recent status appearing as the first item in the array.

JourneyTimes API

Easy

Available to Use

The Journey Times API enables you to define the earliest possible collection time for your parcel and the latest delivery time.

Using this information, we calculate the latest feasible collection time for your parcel or parcels. This service offers timing guidance for all SameDay APIs, assisting you in providing your customer with achievable timeframes.

This proactive approach helps prevent errors that could occur from submitting bookings with unrealistic time constraints.

Delivery Windows

Medium

Q1 2024

Aimed at Retail customers who have different service requirements such as 2hr, and 4hr delivery windows.

Our store-to-home service can help leverage your store's brick-and-mortar estate through urban local delivery. We can offer hyperlocal 2, 3 and 4-hour delivery timeslots for same day or nominated days chosen by your customer.

This API can also be utilised to streamline the process of your customers sending back unwanted or unsuitable items easier with our returns delivery service offering allocated pick-ups.

We will arrange collection from your customer in an agreed timeslot of either 2, 4, 6 or 8 hours and return goods safely back to your local store or DC.

Vehicle details

Easy

Q1 2024

This API collection focuses on helping users determine the appropriate vehicle for their delivery needs. Here's a more detailed breakdown of the two APIs within the collection:

API 1: List of Vehicles with vehicle Type and Dimensions

  • This API provides a comprehensive list of available vehicles.
  • Each vehicle is associated with a unique vehicle code for ease of identification.
  • The dimensions of each vehicle, such as length, width, and height, are included in the information.
  • Users can utilise this API to browse through available vehicle options and their specifications.

API 2: List of Suitable Vehicles based on Criteria provided

  • The second API is designed to assist users in selecting the most suitable vehicle for a specific delivery task.
  • It takes into account various criteria, including:

Cube size: This likely refers to the total volume or capacity of the items being delivered.o Maximum length: The maximum allowable length for items in the delivery.o Box type: The type or shape of the boxes or items being delivered.o Number of boxes: The quantity of boxes or items involved in the delivery.

  • By inputting this information, users can receive a list of vehicles that meets their delivery requirement and streamlines the process of selecting the right vehicle based on the inputs provided in relation to the delivery.

Specialist operations(InNight)

Easy

Q1 2024

This is aimed at different services Citysprint support:

Hub and spoke logistics strategy - Geared towards clients with the need to distribute items to numerous destinations along a designated route, either utilising a local service hub or through our nationwide trunking network in the UK.

Booking can be done through manifests or individual item requests. Typically, the goods are transported either by the customer themselves or via a predetermined route to a CitySprint Service centre.

In-night boot delivery -Dedicated overnight service for delivering to an engineer Van, car boots or location of choice. This service is distinct from our standard logistics operations due to the potential presence of additional needs, such as:

  • Varied pickup locations.
  • Alternative delivery preferences.
  • Trunking through the UK

Specified Delivery Windows

Hard

Q1 2024

Customisable delivery timeframes enabling you to set specific stop durations for all stops within a multi-stop delivery.

This feature will require you to use an expanded version of JourneyTimes API to be able to provide you with achievable time slots for each stop.

Overnight

Medium

Q1 2024

By leveraging our network of service partners, CitySprint can coordinate the delivery of your Overnight delivery.

We'll conveniently pick up your parcels from your location and offer tracking updates through our status APIs, ensuring you have complete visibility of your shipment's journey, from the point of collection to final delivery.

The collection offers *Quote and Booking functionality

*Please be aware that the accuracy of the quotation is contingent upon the correctness of the information provided. Any supplementary charges incurred due to inaccuracies in the data provided will be recharged.

International

Hard

Q1 2024

By leveraging our network of service partners, CitySprint can coordinate the delivery of your International delivery.

We'll pick up your parcels from your specified location and offer tracking updates through our status APIs, ensuring you have complete visibility of your shipment's journey, from the point of collection to final delivery. International shipments will require different information such as Custom invoices and EORI numbers

The collection offers *Quote and Booking functionality

*Please be aware that the accuracy of the quotation is contingent upon the correctness of the information provided. Any supplementary charges incurred due to inaccuracies in the data provided will be recharged.

Note:  In the realm of software development, it's common for timelines to be flexible and prone to adjustments.