Wolt Drive Schemas

Wolt Drive API Schemas

AvailableVenuesListResponse

{
  "pickup": {
    "venue_id": "string",
    "name": [
      {
        "lang": "string",
        "value": "string"
      }
    ],
    "location": {
      "formatted_address": "string",
      "coordinates": {
        "lat": 0,
        "lon": 0
      }
    }
  },
  "fee": {
    "amount": 0,
    "currency": "string"
  },
  "pre_estimate": {
    "pickup_minutes": 0,
    "delivery_minutes": 0,
    "total_minutes": {
      "min": 0,
      "mean": 0,
      "max": 0
    }
  },
  "scheduled_dropoff_time": "string"
}

Parameter	Type	Required	Description
pickup	PickupDetails	Required	Pickup location details
fee	Fee	Required	Delivery price details
pre_estimate	Estimate]	Required	Pre-estimated delivery time

Cash

{
  "amount_to_collect": 0,
  "amount_to_expect": 0
}

Parameter	Type	Required	Description
amount_to_collect	int	Required	Amount of cash to receive (e.g. 60€ order, 20€ credit, customer needs to pay 40€). Value should also include the delivery cost. Price presented in whole numbers in the lowest denomination, commonly cents (example amount 40€ = "4000").
amount_to_expect	int		Amount of cash expected to have change for (e.g. customer has a 50€ bill). Price presented in whole numbers in the lowest denomination, commonly cents.

ContactDetails

{
  "name": "string",
  "phone_number": "string",
  "send_tracking_link_sms": true
}

Parameter	Type	Required	Description
name	string	Required	Name for contact
phone_number	string	Required	Phone number with country code and leading plus symbol. E.g. +358123456789
send_tracking_link_sms	boolean	Required	Send a pre-defined SMS with an order tracking link to the provided phone_number

{
  "count": 0,
  "description": "string",
  "identifier": "string",
  "id_check_required": false,
  "tags": ["alcohol"],
  "price": {
    "amount": 0,
    "currency": "string"
  },
  "dimensions": {
    "weight_gram": 0,
    "width_cm": 0,
    "height_cm": 0,
    "depth_cm": 0
  }
}

Parameter	Type	Required	Description
count	integer	Required	Count of items
description	string	Required	Description of the item, eg. "Burger"
id_check_required	boolean		Defines whether ID check is required. Enable to ask the courier partner to verify customer identity.
identifier	string	Required	Any kind of reference to item, eg. GUID
tags	ContentTag		List of the "features" of the parcel. Tag is visible in courier application.
price	Price		Monetary value of the parcel item. Please include, if available, to enable more order automation.
dimensions	ParcelDimensionsV1		Please include, if available, to enable more order automation.

ContentTag

Parameter	Type	Required	Description
ContentTag	string		List of the "features" of the parcel. Tag is visible in courier application.

Enumerated Values

Property	Value
ContentTag	null
ContentTag	alcohol
ContentTag	medicine
ContentTag	tobacco

Coordinates

{
  "lat": 0,
  "lon": 0
}

Parameter	Type	Required	Description
lat	number	required	Latitude value in EPSG:3857 Coordinate Reference System
lon	number	required	Longitude in EPSG:3857 Coordinate Reference System

Courier

{
  "vehicle_type": "string"
}

Parameter	Type	Required	Description
vehicle_type	string		Courier's vehicle type. Possible values are: "car", "bicycle", "motorcycle", "walking", "flying_drone", "unspecified"

CreateDropoffDetails

{
  "location": {
    "formatted_address": "string",
    "coordinates": {
      "lat": 0,
      "lon": 0
    }
  },
  "contact_details": {
    "name": "string",
    "phone_number": "string",
    "send_tracking_link_sms": true
  },
  "comment": "string"
}

Parameter	Type	Required
location	OrderLocation	Required
contact_details	ContactDetails	Required
comment	string

CreateDropoffLocationV1

{
  "coordinates": {
    "lat": 0,
    "lon": 0
  }
}

Parameter	Type	Required	Description
coordinates	Coordinates	Required	Coordinates have to match those in the shipment promise response.

CreateDropoffOptionsV1

Additional information related to the dropoff

{
  "is_no_contact": false,
  "scheduled_time": "2023-01-23T14:21:00Z"
}

Parameter	Type	Required	Description
is_no_contact	boolean	Default: false
scheduled_time	string(date-time)		Target time for the drop off. Timestamp is in ISO8601 format e.g. 2020-01-30T10:00:13.123Z

CreateDropoffV1

The location with some additional information of the parcels destination

{
  "location": {
    "coordinates": {
      "lat": 0,
      "lon": 0
    }
  },
  "comment": "string",
  "options": {
    "is_no_contact": false,
    "scheduled_time": "2023-01-23T14:21:00Z"
  }
}

Parameter	Type	Required	Description
location	CreateDropoffLocationV1	Required
comment	string		Any additional information related to dropoff in a free text form. Displayed to the courier partner to help finding the recipient easier.
options	CreateDropoffOptionsV1		Additional information related to the dropoff

CreatePickupDetails

{
  "location": {
    "formatted_address": "string",
    "coordinates": {
      "lat": 0,
      "lon": 0
    }
  },
  "comment": "string",
  "contact_details": {
    "name": "string",
    "phone_number": "string",
    "send_tracking_link_sms": true
  },
  "display_name": "string"
}

Parameter	Type	Required	Description
location	OrderLocation	Required
comment	string		Any additional information related to pickup in a free text form. Displayed to the courier partner to help finding the venue/sender easier.
contact_details	ContactDetails	Required
display_name	string		A display name for pickup location, eg. venue name. If not included, pickup address is used in customer, courier and support communication.

CreatePickupV1

{
  "options": {
    "min_preparation_time_minutes": 30
  },
  "comment": "string",
  "display_name": "string
}

Parameter	Type	Description
options	PickupOptionsV1	Additional information related to the pickup
comment	string	Any additional information related to pickup in a free text form. If not included, a pre-added pickup comment is used.
display_name	string	Optional display name for pickup location, eg. venue name. If not included, a pre-added venue name is used. Leave out if unsure if needed.

CustomerSupport

Customer support contact information. It's required to provide a value in at least one of the fields.

At least one of the CustomerSupport fields has to be provided

{
  "email": "string",
  "phone_number": "string",
  "url": "string"
}

Parameter	Type	Description
email	string	Visible in the tracking view.
phone_number	string	Visible in the tracking view.
url	string	Visible in the tracking view.

DeliveryFeeResponse

{
  "created_at": "string",
  "pickup": {
    "location": {
      "formatted_address": "string",
      "coordinates": {
        "lat": 0,
        "lon": 0
      }
    }
  },
  "dropoff": {
    "location": {
      "formatted_address": "string",
      "coordinates": {
        "lat": 0,
        "lon": 0
      }
    }
  },
  "fee": {
    "amount": 0,
    "currency": "string"
  },
  "time_estimate_minutes": 0,
  "scheduled_dropoff_time": "string"
}

Parameter	Type	Required
created_at	string	Required
pickup	PickupDetails	Required
dropoff	DropoffDetails	Required
fee	Fee	Required
time_estimate_minutes	integer
scheduled_dropoff_time	string

DeliveryOrderResponse

{
  "pickup": {
    "eta": "string",
    "location": {
      "formatted_address": "string",
      "coordinates": {
        "lat": 0,
        "lon": 0
      }
    },
    "comment": "string",
    "contact_details": {
      "name": "string",
      "phone_number": "string",
      "send_tracking_link_sms": true
    }
  },
  "dropoff": {
    "eta": "string",
    "location": {
      "formatted_address": "string",
      "coordinates": {
        "lat": 0,
        "lon": 0
      }
    },
    "comment": "string",
    "contact_details": {
      "name": "string",
      "phone_number": "string",
      "send_tracking_link_sms": true
    }
  },
  "scheduled_dropoff_time": "string",
  "customer_support": {
    "email": "string",
    "phone_number": "string",
    "url": "string"
  },
  "is_no_contact": true,
  "merchant_order_reference_id": "string",
  "contents": [
    {
      "count": 0,
      "description": "string",
      "identifier": "string",
      "id_check_required": false,
      "tags": ["alcohol"],
      "price": {
        "amount": 0,
        "currency": "string"
      },
      "dimensions": {
        "weight_gram": 0,
        "width_cm": 0,
        "height_cm": 0,
        "depth_cm": 0
      }
    }
  ],
  "tips": [
    {
      "type": "pre_delivery_courier_tip",
      "price": {
        "amount": 0,
        "currency": "string"
      }
    }
  ],
  "price": {
    "amount": 0,
    "currency": "string"
  },
  "tracking": {
    "id": "string",
    "url": "string"
  },
  "wolt_order_reference_id": "string",
  "min_preparation_time_minutes": 0,
  "order_number": "string"
}

Parameter	Type	Required	Description
pickup	PickupResponseDetails	Required
dropoff	DropoffResponseDetails	Required
scheduled_dropoff_time	string
customer_support	CustomerSupport	Required
is_no_contact	boolean	Required
merchant_order_reference_id	string
contents	[Contents]	Required
tips	[Tip]	Required
price	Price	Required
tracking	Tracking	Required
wolt_order_reference_id	string	Required
min_preparation_time_minutes	integer	Required
order_number	string		A short reference which links back to the delivery order. Suggested to be 5 chars or under. If present, is shown to courier partner instead of `merchant_order_reference_id`.

DeliveryOrderV1

{
  "id": "string",
  "status": "INFO_RECEIVED",
  "tracking": {
    "id": "string",
    "url": "string"
  },
  "pickup": {
    "location": {
      "coordinates": {
        "lat": 0,
        "lon": 0
      },
      "formatted_address": "string"
    },
    "comment": "string",
    "options": {
      "min_preparation_time_minutes": 30
    },
    "eta": "2023-01-23T14:21:00Z",
    "display_name": "string"
  },
  "dropoff": {
    "location": {
      "coordinates": {
        "lat": 0,
        "lon": 0
      },
      "formatted_address": "string"
    },
    "comment": "string",
    "options": {
      "is_no_contact": false,
      "scheduled_time": "2023-01-23T14:21:00Z"
    },
    "eta": "2023-01-23T14:21:00Z"
  },
  "price": {
    "amount": 0,
    "currency": "string"
  },
  "recipient": {
    "name": "string",
    "phone_number": "string",
    "email": "string"
  },
  "parcels": [
    {
      "dimensions": {
        "weight_gram": 0,
        "width_cm": 0,
        "height_cm": 0,
        "depth_cm": 0
      },
      "description": "string",
      "identifier": "string",
      "dropoff_restrictions": {
        "id_check_required": false
      },
      "tags": ["alcohol"],
      "price": {
        "amount": 0,
        "currency": "string"
      }
    }
  ],
  "customer_support": {
    "url": "string",
    "email": "string",
    "phone_number": "string"
  },
  "wolt_order_reference_id": "string",
  "merchant_order_reference_id": "string",
  "tips": [
    {
      "type": "pre_delivery_courier_tip",
      "price": {
        "amount": 0,
        "currency": "string"
      }
    }
  ],
  "order_number": "string"
}

Parameter	Type	Required	Description
id	string	Required
status	DeliveryStatusV1	Required
tracking	TrackingInfoV1	Required
pickup	PickupV1	Required
dropoff	DropoffV1	Required
price	Price	Required
recipient	RecipientV1	Required
parcels	[ParcelV1]	Required
customer_support	CustomerSupport	Required
wolt_order_reference_id	string	Required
merchant_order_reference_id	string
tips	[Tip]
order_number	string		A short reference which links back to the delivery order. Suggested to be 5 chars or under. If present, is shown to courier partner instead of `merchant_order_reference_id`.

DeliveryStatusV1

"INFO_RECEIVED"

DeliveryStatusV1

Parameter	Type	Required	Description
DeliveryStatusV1	string		An enumeration.

Enumerated Values

Property	Value
DeliveryStatusV1	INFO_RECEIVED
DeliveryStatusV1	IN_TRANSIT
DeliveryStatusV1	DELIVERED

DropoffDetails

{
  "location": {
    "formatted_address": "string",
    "coordinates": {
      "lat": 0,
      "lon": 0
    }
  }
}

Parameter	Type	Required	Description
location	OptionalLocation	Required

DropoffOptionsV1

{
  "is_no_contact": false,
  "scheduled_time": "2023-01-23T14:21:00Z"
}

Parameter	Type	Required	Description
is_no_contact	boolean	Default: false
scheduled_time	string(date-time)		Target time for the drop off. Timestamp is in ISO8601 format e.g. 2020-01-30T10:00:13.123Z

DropoffResponseDetails

{
  "eta": "string",
  "location": {
    "formatted_address": "string",
    "coordinates": {
      "lat": 0,
      "lon": 0
    }
  },
  "comment": "string",
  "contact_details": {
    "name": "string",
    "phone_number": "string",
    "send_tracking_link_sms": true
  }
}

Parameter	Type	Required
eta	string	Required
location	OrderLocation	Required
comment	string
contact_details	ContactDetails	Required

DropoffRestrictionsV1

Used when sending eg. age-restricted products_

{
  "id_check_required": false
}

Parameter	Type	Required	Description
id_check_required	boolean		Defines whether ID check is required. Enable to ask the courier partner to verify customer identity.

DropoffV1

{
  "location": {
    "coordinates": {
      "lat": 0,
      "lon": 0
    },
    "formatted_address": "string"
  },
  "comment": "string",
  "options": {
    "is_no_contact": false,
    "scheduled_time": "2023-01-23T14:21:00Z"
  },
  "eta": "2023-01-23T14:21:00Z"
}

Parameter	Type	Required	Description
location	LocationV1	Required
comment	string		Any additional information related to dropoff in a free text form.
options	DropoffOptionsV1		Additional information related to the dropoff
eta	string(date-time)		Drop off ETA. Timestamp is in ISO8601 format e.g. 2020-01-30T10:00:13.123Z. This will be null in scheduled dropoff case

Estimate

{
  "pickup_minutes": 0,
  "delivery_minutes": 0,
  "total_minutes": {
    "min": 0,
    "mean": 0,
    "max": 0
  }
}

Parameter	Type	Required	Description
pickup_minutes	integer	Required	Pre-estimated time from the moment of ordering to pickup completion.
delivery_minutes	integer	Required	Pre-estimated time from pickup event to dropoff completion.
total_minutes	MinMeanMaxEstimate	Required	Min, Mean and Max pre-estimates for the full delivery process.

Fee

{
  "amount": 0,
  "currency": "string"
}

Parameter	Type	Required	Description
amount	integer	Required	Monetary amount presented in whole numbers in the lowest denomination, commonly cents.
currency	string	Required	ISO 4217 three-letter currency code

HandshakeDelivery

{
  "is_required": false,
  "should_send_sms_to_dropoff_contact": true
}

Parameter	Type	Defaults	Description
is_required	boolean	Default: false	Enable PIN verification feature on the delivery. Not supported in all regions, ask your Wolt Drive contact before enabling.
should_send_sms_to_dropoff_contact	boolean	Default: true	When enabled, Wolt will send a pre-defined SMS to recipient including the delivery PIN code. Disable only if PIN is communicated some other way.

IdentityVerificationV1

{
  "name": "string"
}

IdentityVerificationV1

Parameter	Type	Required	Description
name	string	Required

LocationV1

{
  "coordinates": {
    "lat": 0,
    "lon": 0
  },
  "formatted_address": "string"
}

Parameter	Type	Required	Description
coordinates	Coordinates	Required
formatted_address	string

Name

{
  "lang": "string",
  "value": "string"
}

Parameter	Type	Required	Description
lang	string	Required	Language code for localized name.
name	string	Required	Localized pickup name.

MinMeanMaxEstimate

{
  "min": 0,
  "mean": 0,
  "max": 0
}

Parameter	Type	Required	Description
min	integer	Required	Pre-estimated minimum time for the delivery process.
mean	integer	Required	Pre-estimated mean time for the delivery process.
max	integer	Required	Pre-estimated max time for the delivery process.

OptionalLocation

{
  "formatted_address": "string",
  "coordinates": {
    "lat": 0,
    "lon": 0
  }
}

Parameter	Type	Required	Description
formatted_address	string
coordinates	Coordinates

OrderLocation

{
  "formatted_address": "string",
  "coordinates": {
    "lat": 0,
    "lon": 0
  }
}

Parameter	Type	Required	Description
formatted_address	string	Required
coordinates	Coordinates

ParcelDimensionsV1

{
  "weight_gram": 0,
  "width_cm": 0,
  "height_cm": 0,
  "depth_cm": 0
}

Parameter	Type	Required	Description
weight_gram	integer
width_cm	integer
height_cm	integer
depth_cm	integer

ParcelV1

{
  "dimensions": {
    "weight_gram": 0,
    "width_cm": 0,
    "height_cm": 0,
    "depth_cm": 0
  },
  "price": {
    "amount": 0,
    "currency": "string"
  },
  "description": "string",
  "identifier": "string",
  "dropoff_restrictions": {
    "id_check_required": false
  },
  "tags": ["alcohol"],
  "count": 1
}

Parameter	Type	Description
dimensions	ParcelDimensionsV1	Please include, if available, to enable more order automation.
price	Price	Monetary value of the parcel item. Please include, if available, to enable more order automation.
description	string	Description of the item, eg. "Burger"
identifier	string	Any kind of reference to item, eg. GUID
dropoff_restrictions	DropoffRestrictionsV1
tags	[TagV1]	List of the "features" of the parcel. Tag is visible in courier application.
count	integer	Number of items, cannot be smaller than 1. If not provided, count will be 1 by default.

PickupDetails

{
  "venue_id": "string",
  "name": [
    {
      "lang": "string",
      "value": "string"
    }
  ],
  "location": {
    "formatted_address": "string",
    "coordinates": {
      "lat": 0,
      "lon": 0
    }
  }
}

Parameter	Type	Required	Description
venue_id	string		Wolt venue ID, if available
name	[Name]		List of localized pickup location (venue) names
location	OptionalLocation	Required	Pickup location details

PickupOptionsV1

{
  "min_preparation_time_minutes": 30
}

Parameter	Type	Required	Description
min_preparation_time_minutes	integer	Default: 30	Minimum time in minutes it takes to prepare the order for pickup. When shipment promise ID is included in request, this field is ignored.

PickupResponseDetails

{
  "eta": "string",
  "location": {
    "formatted_address": "string",
    "coordinates": {
      "lat": 0,
      "lon": 0
    }
  },
  "comment": "string",
  "contact_details": {
    "name": "string",
    "phone_number": "string",
    "send_tracking_link_sms": true
  }
}

Parameter	Type	Required
eta	string	Required
location	OrderLocation	Required
comment	string
contact_details	ContactDetails	Required

PickupV1

{
  "location": {
    "coordinates": {
      "lat": 0,
      "lon": 0
    },
    "formatted_address": "string"
  },
  "comment": "string",
  "options": {
    "min_preparation_time_minutes": 30
  },
  "eta": "2023-01-23T14:21:00Z",
  "display_name": "string"
}

Parameter	Type	Required	Description
location	LocationV1	Required
comment	string		Any additional information related to pickup in a free text form.
options	PickupOptionsV1		Additional information related to the pickup
eta	string(date-time)	Required	Pre-estimated time for pickup
display_name	string		Additional display name for pickup location, eg. venue name.

Price

{
  "amount": 0,
  "currency": "string"
}

Parameter	Type	Required	Description
amount	integer	Required	Monetary amount presented in whole numbers in the lowest denomination, commonly cents.
currency	string	Required	ISO 4217 three-letter currency code

RecipientV1

{
  "name": "string",
  "phone_number": "string",
  "email": "string"
}

Parameter	Type	Required	Description
name	string	Required	Name of delivery recipient. Must be non-empty string.
phone_number	string	Required	Phone number with a country code, e.g. +358501234567
email	string		Recipient email address

Promise contains calculated price and estimated delivery time based on destination location. It can be binding in case when the location is detailed enough for price and time estimate to be accurate. Also it can be non-binding which means that location is not precise enough and price and time are rough estimates. In case of non-binding promise it is not possible to create a delivery order using the promise.

{
  "id": "string",
  "created_at": "2023-01-23T14:21:00Z",
  "valid_until": "2023-01-23T14:21:00Z",
  "pickup": {
    "venue_id": "string",
    "location": {
      "coordinates": {
        "lat": 0,
        "lon": 0
      },
      "formatted_address": "string"
    },
    "options": {
      "min_preparation_time_minutes": 0
    },
    "eta_minutes": 0
  },
  "dropoff": {
    "location": {
      "coordinates": {
        "lat": 0,
        "lon": 0
      },
      "formatted_address": "string"
    },
    "options": {
      "scheduled_time": "2023-01-23T14:21:00Z"
    },
    "eta_minutes": 0
  },
  "price": {
    "amount": 0,
    "currency": "string"
  },
  "time_estimate_minutes": 0,
  "is_binding": true,
  "parcels": [
    {
      "dimensions": {
        "weight_gram": 0,
        "width_cm": 0,
        "height_cm": 0,
        "depth_cm": 0
      },
      "price": {
        "amount": 0,
        "currency": "string"
      },
      "count": 1
    }
  ]
}

Parameter	Type	Required	Description
id	string	Required	Promise id is used for creating a delivery order.
created_at	string(date-time)	Required	Timestamp is in ISO8601 format e.g. 2020-01-30T10:00:13.123Z
valid_until	string(date-time)	Required	Determines when the shipment promise will expire.Timestamp is in ISO8601 format e.g. 2020-01-30T10:00:13.123Z
pickup	ShipmentPromisePickupV1	Required
dropoff	ShipmentPromiseDropoffV1	Required
price	Price	Required	Estimated delivery fee based on provided details.
time_estimate_minutes	integer	Required	WARNING: this field is deprecated, use dropoff.eta_minutes or dropoff.options.scheduled_time in order to determine the delivery estimate.
is_binding	boolean	Required	Determines if further delivery order can be created from this promise.
parcels	[ParcelV1]		Parcel details, if provided in the request.

ShipmentPromiseDropoffOptionsV1

{
  "scheduled_time": "2023-01-23T14:21:00Z"
}

Parameter	Type	Required	Description
scheduled_time	string(date-time)		Target time for the drop off. Timestamp is in ISO8601 format e.g. 2020-01-30T10:00:13.123Z

ShipmentPromiseDropoffV1

{
  "location": {
    "coordinates": {
      "lat": 0,
      "lon": 0
    },
    "formatted_address": "string"
  },
  "options": {
    "scheduled_time": "2023-01-23T14:21:00Z"
  },
  "eta_minutes": 0
}

Parameter	Type	Required	Description
location	LocationV1	Required
options	ShipmentPromiseDropoffOptionsV1
eta_minutes	integer		Drop off ETA in minutes. This will be null in scheduled dropoff case

ShipmentPromisePickupOptionsV1

{
  "min_preparation_time_minutes": 0
}

Parameter	Type	Required	Description
min_preparation_time_minutes	integer	Required

ShipmentPromisePickupV1

{
  "venue_id": "string",
  "location": {
    "coordinates": {
      "lat": 0,
      "lon": 0
    },
    "formatted_address": "string"
  },
  "options": {
    "min_preparation_time_minutes": 0
  },
  "eta_minutes": 0
}

Parameter	Type	Required	Description
venue_id	string
location	LocationV1	Required
options	ShipmentPromisePickupOptionsV1	Required
eta_minutes	integer	Required	Pickup ETA in minutes

SmsNotifications

{
  "received": "string",
  "picked_up": "string"
}

Parameter	Type	Required	Description
received	string		Content to be sent as sms when order is received. The content should contain a placeholder for the tracking link: TRACKING_LINK. Example: "Hello John Doe! Your order from Amazing Store will be delivered soon. You can follow it here: TRACKING_LINK".
picked_up	string		Content to be sent as sms when order is picked up. The content should contain a placeholder for the tracking link: TRACKING_LINK. Example: "Hello John Doe! Your order from Amazing Store has been picked up and will be delivered soon. You can follow it here: TRACKING_LINK".

TagV1

"alcohol"

Parameter	Type	Required	Description
TagV1	string		List of the "features" of the parcel. Tag is visible in courier application.

Enumerated Values

Property	Value
TagV1	null
TagV1	alcohol
TagV1	medicine
TagV1	tobacco

Tip

{
  "type": "pre_delivery_courier_tip",
  "price": {
    "amount": 0,
    "currency": "string"
  }
}

Parameter	Type	Required	Description
type	TipType	Required	An enumeration.
price	Price	Required

TipType

"pre_delivery_courier_tip"

Parameter	Type	Required	Description
TipType	string		An enumeration.

Enumerated Values

Property	Value
TipType	pre_delivery_courier_tip

Tracking

{
  "id": "string",
  "url": "string"
}

Parameter	Type	Required	Description
id	string	Required
url	string	Required

TrackingInfoV1

{
  "id": "string",
  "url": "string"
}

Parameter	Type	Required	Description
id	string	Required
url	string	Required

WebHookDetailsV1

{
  "callback_config": {
    "exponential_retry_backoff": {
      "exponent_base": 0,
      "max_retry_count": 0
    }
  },
  "callback_url": "string",
  "created_at": "string",
  "disabled": true,
  "id": "string",
  "modified_at": "string",
  "subscribed_events": ["string"]
}

Parameter	Type	Required	Description
callback_config	WebhookCallbackConfigV1	Required
callback_url	string	Required	End-point url where webhook events are sent.
created_at	string	Required	Timestamp is in ISO8601 format e.g. 2020-01-30T10:00:13.123Z
disabled	boolean	Default: false	Determines whether the webhook is in use and events should be sent.
modified_at	string	Required	Timestamp is in ISO8601 format e.g. 2020-01-30T10:00:13.123Z
subscribed_events	[string]	Required	The list of events a webhook sends updates about.

WebhookCreatePayloadV1

{
  "callback_config": {
    "exponential_retry_backoff": {
      "exponent_base": 2,
      "max_retry_count": 10
    }
  },
  "callback_url": "string",
  "client_secret": "string",
  "disabled": false
}

Parameter	Type	Required	Description
callback_config	WebhookCallbackConfigV1	Required
callback_url	string	Required	End-point url where webhook events are sent.
client_secret	string	Required	A string which is used to sign the webhook event payload.
disabled	boolean	Default: false	Determines whether the webhook is in use and events should be sent.

WebhookUpdatePayloadV1

{
  "callback_config": {
    "exponential_retry_backoff": {
      "exponent_base": 2,
      "max_retry_count": 10
    }
  },
  "callback_url": "string",
  "client_secret": "string",
  "disabled": false,
  "subscribed_events": ["order.received"]
}

Parameter	Type	Description
callback_config	WebhookCallbackConfigV1
callback_url	string	End-point url where webhook events are sent.
client_secret	string	A string which is used to sign the webhook event payload.
disabled	boolean	A string which is used to sign the webhook event payload.
subscribed_events	string	An array of enumerated event types

WebhookCallbackConfigV1

{
  "exponential_retry_backoff": {
    "exponent_base": 0,
    "max_retry_count": 0
  }
}

Parameter	Type	Required	Description
exponential_retry_backoff	exponential_retry_backoff	Required	This configuration is going to be applied when sending a webhook event fails and there is a need to resend it. The strategy applied is exponential backoff when we delay every consequent retry exponentially according to formula exponent_base^n where n is an integer number increasing from 0 to max_retry_count.

ExponentialRetryBackoffStrategyV1

This configuration is going to be applied when sending a webhook event fails and there is a need to resend it. The strategy applied is exponential backoff when we delay every consequent retry exponentially according to formula exponent_base^n where n is an integer number increasing from 0 to max_retry_count.

{
  "exponent_base": 0,
  "max_retry_count": 0
}

Parameter	Type	Required	Description
exponent_base	integer	Required	Base of the exponent in `retry_delay = base^n` calculating the delay in seconds until the next retry attempt to deliver webhook event.
max_retry_count	integer	Required	The number of times webhook event will be resent.

WebhookParcelArray

[
  {
    "description": "string",
    "identifier": "string"
  }
]

Parameter	Type	Required	Description
description	string		Item's description as received in delivery creation.
identifier	string		Item's identifier as received in delivery creation.

WebhookDropoffEta

{
  "dropoff": {
    "eta": {
      "min": "2023-01-01T00:00:00.000Z",
      "max": "2023-01-01T00:00:00.000Z"
    },
    "completed_at": "2023-01-01T00:00:00.000Z"
  }
}

Parameter	Type	Description
dropoff.eta
dropoff.eta.min	string	Earliest dropoff time estimate.
dropoff.eta.max	string	Latest dropoff time estimate.
completed_at	string	Time of completing the delivery. Included in `order.delivered` and otherwise null