Sign in

v1

latestOpenAPI 3.0.32026-07-132612241.2 MB
tasks

put/tasks/{id}/

Path parameters

idstring uuid required

A UUID string identifying this task.

Query parameters

format'json' | 'xml'
order__orderer__companystring
order__orderer__company__icontainsstring
order__orderer__company__iexactstring
order__orderer__company__istartswithstring
order__orderer__emails__contained_bystring

Filter the returned list where all target array values contained in filter values. Comma separated values supported

order__orderer__emails__containsstring

Filter the returned list where all filter_values are present. Comma separated values supported

order__orderer__emails__overlapstring

Filter the returned list where at least one filter value in target array. Comma separated values supported

order__orderer__namestring
order__orderer__name__icontainsstring
order__orderer__name__iexactstring
order__orderer__name__istartswithstring
order__orderer__notesstring
order__orderer__notes__icontainsstring
order__orderer__notes__iexactstring
order__orderer__notes__istartswithstring
order__orderer__phones__contained_bystring

Filter the returned list where all target array values contained in filter values. Comma separated values supported

order__orderer__phones__containsstring

Filter the returned list where all filter_values are present. Comma separated values supported

order__orderer__phones__overlapstring

Filter the returned list where at least one filter value in target array. Comma separated values supported

Request body

idstring uuid nullable
external_idstring nullable
referencestring
barcodesstring[]
urlstring uri required
accountstring uri required
state'unassigned' | 'assigned' | 'accepted' | 'transit' | 'active' | 'completed' | 'failed' | 'cancelled' required
assigneestring uri nullable
orderstring uri nullable
ordererstring uri nullable
orderer_namestring required
routestring uri nullable
category'assignment' | 'pick_up' | 'drop_off' | 'warehouse'
contact_addressstring uri nullable
contact_address_external_idstring nullable
descriptionstring
complete_afterstring date-time nullable
complete_beforestring date-time nullable
scheduled_timestring date-time nullable
completed_atstring date-time required
cancelled_atstring date-time required
auto_assignboolean
assignee_proximity'away' | 'near' required
positionnumber double nullable
priorityinteger
durationobject nullable
sizeinteger[] nullable
formsobject required
documentsstring[]
signaturesstring[]
metafieldsobject
trackersstring[] required
issuesstring[] required
countsobject required
actionsobject required
created_atstring date-time required
updated_atstring date-time required