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.
| Field | Type | Description |
|---|---|---|
line1 | string | |
line2 | string | |
city | string | |
postcode | string | |
country | string |
AllocationReview
| Field | Type | Description |
|---|---|---|
splitrequired | boolean | |
changed | boolean | |
taskIds | integer (int32)[] | |
review | object |
Cancellation
| Field | Type | Description |
|---|---|---|
consolidationIdrequired | string | |
cancelledTaskIdsrequired | integer (int32)[] | Tasks cancelled by this call; empty on a successful repeat. |
CustomerDetails
| Field | Type | Description |
|---|---|---|
splitrequired | boolean | |
consolidationId | string | |
customerTaskId | integer (int32) | Omitted before onward task creation. |
addressId | integer (int32) | |
address | object | |
postcode | string | |
timezone | string | |
from | string (date-time) | |
to | string (date-time) | |
instructions | string |
CustomerEdit
Supply date OR both from/to, never both forms. All supplied changes remain subject to delivery eligibility.
| Field | Type | Description |
|---|---|---|
address | AddressEdit | |
date | string (date) | Local date in the group timezone; preserves the current local window times. |
from | string (date-time) | |
to | string (date-time) | |
instructions | string | Omit to preserve; empty string clears. |
CustomerSync
| Field | Type | Description |
|---|---|---|
splitrequired | boolean | |
staterequired | string | For example SYNCED, NOT_CHECKED, PENDING, CLOSED, CANCELLED, or an operation/error state. Preserve unfamiliar values for review. |
operationId | string |
Error
| Field | Type | Description |
|---|---|---|
errorrequired | string |
ParcelLabels
Manifest metadata, not a PDF or authorization to dispatch.
| Field | Type | Description |
|---|---|---|
splitrequired | boolean | |
taskIdrequired | integer (int32) | |
bookingReadyrequired | boolean | |
deliveryReadyrequired | boolean | |
consolidationId | string | |
mfcLocationId | integer (int64) | |
labelsrequired | object[] |
RevisionApplication
A saved progress record, not proof of successful application. An ordinary task with no application can return an empty record.
| Field | Type | Description |
|---|---|---|
id | integer (int64) | |
consolidationId | string | |
revisionId | string | |
state | string | |
errorCode | string | |
result | object | |
replacementRequired | boolean | |
createdAt | string (date-time) | |
updatedAt | string (date-time) |
RevisionPreview
| Field | Type | Description |
|---|---|---|
idrequired | string | |
consolidationId | string | |
staterequired | string | |
planrequired | object | Reviewed plan including blockers, locked parcels and affected sources. Inspect before applying. |
createdAt | string (date-time) |
SplitOrder
| Field | Type | Description |
|---|---|---|
splitrequired | boolean | |
consolidationId | string | |
taskIds | integer (int32)[] | |
lineItems | object[] |
