There are various ways of inputting delivery charges in the CRM. In this article, we'll explain how to do this via a custom procedure via an API. If you wish to use our standard delivery charge options instead, click here to learn more.
Prerequisites
You'll need CRM Admin rights in order to follow the steps in this article
You'll need an externally hosted API
Step 1: Configure Custom Delivery Charges
Navigate to System Settings and search 'Delivery Charges' or click here.
Select 'Custom' for your automatic calculation method.
Step 2: Enter your API Endpoint
You will now have the option to enter your API Endpoint. This is the endpoint from your external API developed to calculate the Delivery Charges.
Step 3: API Technical Details
Once you have configured the Delivery Charges System Setting, when a Quote's delivery charges are calculated, your API endpoint will be hit with a payload of the Quote entity data. Please see our API Docs here for details on what data shape the payload will have.
Your API should then return application/json with the following:
{
"success": boolean, // If the request was successful
"options"?: Array<PriceOption>, // Optionally any delivery options for the user to select from
"messageId"?: string; // Optional message to show to the user
}
PriceOption {
RowId?: number;
ProductItemId: string;
Description: string;
Price: number;
ExtendedDescription?: string;
}If no options are returned, your custom calculation endpoint should use our API to set the delivery charge values onto the Quote manually.
Prefer our Consultants to create this for you? Get in touch with the Team here to be sent a quote!