All Collections
Developer & API
Configuring Custom Delivery Charges
Configuring Custom Delivery Charges

This article outlines how to configure your own custom delivery charges.

Isobel Honour avatar
Written by Isobel Honour
Updated over a week ago

There are various ways of inputting delivery charges in Prospect. In this article, we'll explain how to do this via a custom procedure on the database. If you wish to use our standard delivery charge options instead, click here to learn more.

To configure Custom Delivery Charges, a procedure must be written in SQL. Once you have done this you will need to contact Support to run this on your database and complete the steps below.

Step 1: Rules for the Procedure

The procedure must be called dba.xp_custom_deliverycharge


It has an execution limit of 10 seconds on the procedure - anything longer than this will error.

An example of a simple procedure showing the result set to return:

Step 2: Configuring the Custom Delivery Charge

The Quote number is sent to the procedure so you can calculate using whatever information you require.


You configure them in the same way as bespoke custom delivery charge endpoints using the system option:

In Automatic Calculations within the Delivery Charge setting under System Settings, select 'Custom' and enter the following URL:

https://api-v1.prospect365.com/Quotes/GetCustomDeliveryCharges


Possible errors

  • "Invalid request data" - The endpoint couldn’t locate a Quote ID in the POST data.

  • "Custom delivery charges not configured" - The endpoint has been used but no calculation procedure exists.

  • "Custom delivery charge calculations timed out" - The call to the procedure/reader took more than 10 seconds.

  • "Unable to calculate using custom delivery charges" - Something else went wrong. Check app insights for an error at this time.

Did this answer your question?