Throughout This Page
You can jump to the specified sections by clicking on these titles.
Overview
Within the Courier API, we incorporate frequently used service presets for each courier. Our system continually updates these presets to ensure that our customers can readily access the latest and most popular services. We refer to these as "System Presets" within the Courier API. It eliminates the need to search for service codes or manually add them to your account. Your task is to select the desired presets, allowing your parcel to be sent using the chosen service.
This documentation will provide you with insight into the Courier Directory segment. Here, you can review the available system presets for a particular courier. Additionally, we will guide you through adding a courier service to the Courier API and creating your custom presets. Finally, we'll walk you through the steps of utilizing the courier presets when initiating a shipment request.
Courier Directory
To access the system presets, navigate to the "Courier Directory" page by selecting it from the menu on the left-hand side.
The Courier Directory page comprehensively lists all integrated couriers within the Courier API. To explore the system presets available for a particular courier, click on the respective courier's logo in the directory.
The primary objective of the Courier Directory is to enable you to utilize our pre-configured system presets and create custom presets tailored to each of your API accounts. These service presets are pre-defined codes designed to grant access to each courier's services.
For instance, selecting "DPD" will reveal a compilation of all the system presets corresponding to the available services offered by DPD.
Custom Presets
Kindly consult our specialized page on custom presets to gain insights into this functionality.
How to Use Courier Presets
Within the Courier API, we've developed a virtual environment known as the Playground. This feature enables you to initiate requests directly from our application, providing an experiential understanding of the processes involved when transmitting a request from your application to the Courier API.
It's important to note that when utilising actual API credentials in the Playground, there's a possibility of incurring charges from the courier to submit requests.
For instance, examining the request illustrated in the image below, we've employed "ROYALMAIL-CRL1-P" as the "dc_service_id".
You'll find the utilised preset upon navigating to the "Courier Directory" and selecting Royal Mail.
Upon selecting the "DC Service ID," we automatically submit the following data within the courier JSON on your behalf: "Service Level" (01), "Service Code" (CRL1), and "Service Format" (P). The only non-submitted value is the Posting Location. This exception is due to the Posting Location being the sole variable. These three parameters remain constant for the specific service, whereas the variable aspect is the Posting Location.
A custom preset named "Royal Mail 24 Test" is generated, with "RM24TEST" as the DC Service ID. Instead of inputting "ROYALMAIL-CRL1-P" or any other Service ID, you can now utilise the "RM24TEST" service designation within the Playground.
Observe that we've omitted the "courier" JSON section, as the necessity to specify the Posting Location is obviated by "RM24TEST". When you transmit the request, the label is generated in the customary manner (RM24), yet you're no longer required to include a Posting Location.
You have two options: employ our standard-format Service IDs and include the Posting Location in the courier JSON with each request, or you can configure one or two services as custom options linked to a specific API Account.
These alternatives achieve the same outcome, yet the latter option demands less effort and offers a workaround if this poses a challenge.
The service directory offers various capabilities to facilitate streamlined data transmission, minimising the need to juggle various codes.
Courier Specifics
As mentioned in this documentation, the particulars necessary for presets can vary among couriers. You can familiarize yourself with these requirements for each courier by referring to the Courier Specifics Documentation.
For instance, upon accessing the "DPD" service directory and examining a preset, you'll notice that the Network Code remains consistent and no additional JSON data is needed for the requests. Hence, the only requisite is to have the courier credentials for authorization.
Alternatively, when reviewing the Hermes Corporate presets, you'll observe that this courier has no mandatory fields.
However, when considering Royal Mail, there are essential elements such as the Posting Location, Service Level, Service Format, and Service Code.
As demonstrated earlier, all of these can be conveniently managed through a custom preset to simplify the process for your convenience.
