Documentation contents

Split fulfilment API schemas

Every model in the Split fulfilment API, in alphabetical order. 11 in total.

AddressEdit

Existing CreateAddressRequest fields. Postcode is required when creating a new address.

FieldTypeDescription
line1string
line2string
citystring
postcodestring
countrystring

AllocationReview

FieldTypeDescription
splitrequiredboolean
changedboolean
taskIdsinteger (int32)[]
reviewobject

Cancellation

FieldTypeDescription
consolidationIdrequiredstring
cancelledTaskIdsrequiredinteger (int32)[]Tasks cancelled by this call; empty on a successful repeat.

CustomerDetails

FieldTypeDescription
splitrequiredboolean
consolidationIdstring
customerTaskIdinteger (int32)Omitted before onward task creation.
addressIdinteger (int32)
addressobject
postcodestring
timezonestring
fromstring (date-time)
tostring (date-time)
instructionsstring

CustomerEdit

Supply date OR both from/to, never both forms. All supplied changes remain subject to delivery eligibility.

FieldTypeDescription
addressAddressEdit
datestring (date)Local date in the group timezone; preserves the current local window times.
fromstring (date-time)
tostring (date-time)
instructionsstringOmit to preserve; empty string clears.

CustomerSync

FieldTypeDescription
splitrequiredboolean
staterequiredstringFor example SYNCED, NOT_CHECKED, PENDING, CLOSED, CANCELLED, or an operation/error state. Preserve unfamiliar values for review.
operationIdstring

Error

FieldTypeDescription
errorrequiredstring

ParcelLabels

Manifest metadata, not a PDF or authorization to dispatch.

FieldTypeDescription
splitrequiredboolean
taskIdrequiredinteger (int32)
bookingReadyrequiredboolean
deliveryReadyrequiredboolean
consolidationIdstring
mfcLocationIdinteger (int64)
labelsrequiredobject[]

RevisionApplication

A saved progress record, not proof of successful application. An ordinary task with no application can return an empty record.

FieldTypeDescription
idinteger (int64)
consolidationIdstring
revisionIdstring
statestring
errorCodestring
resultobject
replacementRequiredboolean
createdAtstring (date-time)
updatedAtstring (date-time)

RevisionPreview

FieldTypeDescription
idrequiredstring
consolidationIdstring
staterequiredstring
planrequiredobjectReviewed plan including blockers, locked parcels and affected sources. Inspect before applying.
createdAtstring (date-time)

SplitOrder

FieldTypeDescription
splitrequiredboolean
consolidationIdstring
taskIdsinteger (int32)[]
lineItemsobject[]

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