Task API
Create and manage deliveries and store collections. For a collection, use the location's merchantLocationId and the QUIV_COL rate returned by /quotes. Store collection is stock-only in v1; select a location that has collection enabled and current stock for the full basket.
- Base URL
https://api.quiver.london/task- Authentication
x-api-keyheader- Version
- 1.0
What is a quote?
The quote resource facilitates the booking of a task by determining the eligibility of an order and its address for each task and delivery type. A quote is composed of a list of rates.
A rate corresponds to a specific task and delivery type. This mapping is represented by a code e.g QUIV_DEL_IM is a rate for an Immediate Delivery, whereas QUIV_RET is a rate for a Return. Each rate is evaluated individually and as such a quote may only successfully evaluate a subset of the rates. A rate is ineligible if it has an error. A rate is eligible if it has a price, description and window.
A quote is deemed to be stale if any of the aforementioned details change or a reasonable amount of time has passed (typically 2 minutes, we can work together to determine a more applicable value for a reasonable amount of time). If a quote is stale, a new quote must be created to ensure the order is still eligible with Quiver.
What is a delivery?
The delivery resource is the object representing a Quiver Delivery. A delivery object has all the details of the quote, as well as indicating the status of a delivery and its tracking information.
Follow here to create a delivery.
A prerequisite to booking a delivery is the successful creation of a quote.
What is a return?
The delivery resource is the object representing a Quiver Return. A return object has all the details of the quote, as well as indicating the status of a delivery and its tracking information.
Follow here to create a return.
A prerequisite to booking a delivery is the successful creation of a quote.
TaskService
- GET
/deliveries - POST
/deliveries - GET
/deliveries/{taskId} - PATCH
/deliveries/{taskId} - POST
/deliveries/{taskId}/statuses - GET
/returns - POST
/returns - GET
/returns/{taskId} - PATCH
/returns/{taskId} - PATCH
/task-attempts/{taskAttemptId} - POST
/tasks - POST
/tasks:batchDownloadLabels - POST
/tasks/{taskId}/attempts - PATCH
/tasks/{taskId}/ready-for-collection - POST
/tasks/{taskId}/status-attempt
QuoteService
- POST
/quotesReturns the delivery and collection rates currently available for the requested basket and destination. Use the returned rate code when booking.
All 62 schemas for this API, in one place.
