Throughout This Page
You can jump to the specified sections by clicking on these titles.
Overview
Our range of courier integrations boasts diverse service options, including popular choices like Proof of Delivery (POD), Saturday delivery, and next-day delivery. The Courier API simplifies this process by providing commonly used service presets for each courier, continually updating these presets to offer up-to-date and sought-after services. These are known as "System Presets" within the Courier API system. You're spared from seeking service codes or manually adding them to your account.
You can select your preferred options and your parcel will be assigned the chosen service. This document will guide you through adding a courier service to the Courier API. Specifically, we'll delve into the Courier Directory section, where you can readily access the available system presets for any courier.
Creating Custom Courier Presets
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 overviews all available courier integrations within the Courier API. To view the predefined system presets for a specific courier, click on the corresponding courier's logo within the directory.
The primary purpose of the Courier Directory is to enable the utilization of existing system presets and the creation of custom presets tailored to individual API accounts.
System presets are preconfigured settings granting access to each courier's distinct services.
For instance, upon clicking on the DPD entry, you will be presented with an inventory of the available system presets associated with DPD.
If the desired service preset is not found among the provided options, you can add it yourself. Before proceeding, ensure you have chosen the appropriate API account if you manage multiple accounts.
To create a custom preset, locate the "Create Preset" button in the upper-right corner of the interface.
Subsequently, provide the requisite details, including preset name, service ID, anticipated lead time, and mandatory fields specific to the chosen courier.
It's worth noting that the information required for presets may vary across different couriers. You can check the next section to learn more about the courier specific requirements.
Should you wish to apply this new preset selectively, you can mark the "Apply restrictions to this preset" checkbox and define rules by selecting specific parameters:
Within this section, you can tailor your shipments by directing them through a new service preset based on weight, dimensions, value, and more. For example, you can designate a preset for shipments exceeding £40 but falling below £120 or restrict it to shipments destined for certain postcode regions.
Furthermore, you have the option to designate the countries where this preset will be applicable:
If you possess multiple API accounts and intend to extend this new preset's availability, check the "Add to multiple accounts" checkbox. Proceed to select the relevant API accounts, or use the "All Accounts" button to apply this change across all your accounts.
Upon finalizing all the configurations, click "Create Preset." The newly established preset will be listed with a "custom" label, signifying a custom service exclusive to the associated account.
Feel free to revisit the courier directory whenever necessary to access the courier you've tailored a custom preset for. Here, you can edit or delete your custom presets as needed.
Courier Specific Documentation
It's important to note that presets' particulars can vary across couriers.
To gain insight into these distinct requirements and specifics for each courier, refer to the dedicated documentation page for it.
This resource provides comprehensive information about each courier's preset's unique details and criteria.