Documentation contents

/deliveries

Task API · TaskService

POSThttps://api.quiver.london/task/deliveries

Send your API key in the x-api-key header. See Getting started.

Booking confirmation and retries

  • A 200 response means the delivery has been booked. Save the returned taskId; do not submit another booking.
  • If the requested service is unavailable, Quiver may accept the booking using another available service, preferring Next Day. Use the returned deliveryType and delivery window as the confirmed booking details.
  • If you receive “already exists”, use the existing task identified in the error. Do not change merchantOrderId or add suffixes to retry the same booking.
  • If a request times out, check for an existing delivery before resubmitting. You can query GET /task/deliveries using the original merchantOrderId.

Split fulfilment

For direct API integrations, see Split fulfilment for automatic split booking, whole-order reads, eligible customer edits, labels and cancellation. Standalone automatic split booking is available for opted-in API merchants using Quiver-managed inventory. Caller-specified source/product revisions remain unsupported; see the guide for prerequisites and physical-state rules.

Request body

application/json, shaped as taskCreateTaskRequest.

Responses

StatusBodyDescription
200taskTaskA successful response.
defaultrpcStatusAn unexpected error response.

Request and response bodies

Field types that name another model link to all schemas.

rpcStatus

FieldTypeDescription
codeinteger (int32)
messagestring
detailsprotobufAny[]

taskCreateTaskRequest

FieldTypeDescription
deliveryTypetaskDeliveryType
collectiontaskCreateTaskPartRequestProvide this part when booking a store collection. Use the selected location's merchantLocationId and the QUIV_COL rate from /quotes.
deliverytaskCreateTaskPartRequest
customerrequiredtaskCreateContactRequest
orderrequiredtaskCreateOrderRequest
purchasertaskCreateContactRequest
customerProfileIdinteger (int32)
notestring
linkedTasksinteger (int32)[]
rateCodesharedRateCodeThe rate code returned by /quotes. Use QUIV_COL for store collection.

taskTask

FieldTypeDescription
taskIdinteger (int32)
createdAtstring (date-time)
updatedAtstring (date-time)
taskTypesharedTaskType
merchantNamestring
modesharedMode
statustaskTaskStatusUpdate
fulfilmentTypefulfilmentFulfilmentType
deliveryTypetaskDeliveryType
collectiontaskTaskPart
deliverytaskTaskPart
ordertaskOrder
customertaskContact
purchasertaskContact
customerProfileIdinteger (int32)
trackingIdstring
trackingUrlstring
trackingAccessKeystring
surchargeboolean
co2Savingsnumber (double)
notestaskTaskNote[]
statusUpdatestaskTaskStatusUpdate[]
updatessharedTaskUpdate[]
rateCodesharedRateCode
linkedTasksinteger (int32)[]
readyForCollectionboolean
onTimeboolean
onTimeDeviationMinutesinteger (int32)
attemptstaskTaskAttempt[]
ageRestrictionsharedAgeRestrictionSet when the order holds age-restricted goods (merchant default, product override or a client flag). Absent means not restricted.

Quiver Solutions Limited · Registered in England and Wales, company number 16961611 · 27 Old Gloucester Street, London WC1N 3AX

How We Work
Pricing
Reviews
Become a Courier
Jobs
3