HomeGuidesAPI DocumentationAPI UpdatesAsk a QuestionStatus Page
API Documentation

Validate Delivery Job

webhook
https://yourwebhook.com/validate_job

Purpose

The initial dispatch notification that one or multiple delivery jobs are needing validated as being deliverable i.e. a Courier is available for the provided delivery job specification.

The Validate Webhook URL needs to be standardised, i.e. the same URL should be used for every customer installation.

Request Parameters

See full list of order attributes below;

▶ Delivery Job Model

Error codes

If delivery is not possible, one or more of the following error codes are expected to be returned in the response;

▶ Error Codes

Delivery Address Coordinates
In the rare event that the coordinates are not included in the payload, you should still validate the delivery job, as the delivery address details are always provided.

Response

Below is an examples of the expected response from the dispatch platform;

Required Parameters
All parameters shown in the response model are required. Omitting any of these parameters will prevent the Create Delivery Job request from being triggered

Response Parameters

All parameters shown in the response payload are required. Missing out will result in the create call request not to be triggered, see full list delivery model in link below;

▶ Delivery Job Model


Payload
string
string
date-time
string
integer
pickupLocation
object
deliveryLocations
array of objects
deliveryLocations
boolean
Headers
string
required
Defaults to Deliverect/{version}

Identifies Deliverect as the sender of the webhook, in the format Deliverect/{version}.

string
required
Defaults to {signature}

HMAC-SHA256 signature of the raw request body, generated with your shared secret. Recompute the signature on receipt and compare it to this value to verify the request came from Deliverect (see the HMAC authentication guide).

Responses

Updated 5 days ago

Did this page help you?
LoadingLoading…

Updated 5 days ago

Did this page help you?