tasks

post/tasks/reposition/

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

Changes

Changed in 6 of the 6 revisions of this API.62248

    • media type application/json; version=2.4.12 was changed to application/json; version=2.4.13 for the response status 200

      response-media-type-name-changed

    • media type application/xml; version=2.4.12 was changed to application/xml; version=2.4.13 for the response status 200

      response-media-type-name-changed

  • b89c1b3e6d09212See the full diff
    • the response property address became optional for the status 200 (media type: application/json; version=2.4.12)

      response-property-became-optional

    • the response property address became optional for the status 200 (media type: application/xml; version=2.4.12)

      response-property-became-optional

    • added the new optional request property contact_address (media type: application/json)

      new-optional-request-property

    • added the new optional request property contact_address (media type: application/xml)

      new-optional-request-property

    • added the new optional request property contact_address_external_id (media type: application/json)

      new-optional-request-property

    • added the new optional request property contact_address_external_id (media type: application/xml)

      new-optional-request-property

    • the request property address became optional (media type: application/json)

      request-property-became-optional

    • the request property address became optional (media type: application/xml)

      request-property-became-optional

    • media type application/json; version=2.4.11 was changed to application/json; version=2.4.12 for the response status 200

      response-media-type-name-changed

    • media type application/xml; version=2.4.11 was changed to application/xml; version=2.4.12 for the response status 200

      response-media-type-name-changed

    • added the optional write-only property contact_address to the response with the 200 status (media type: application/json; version=2.4.12)

      response-optional-write-only-property-added

    • added the optional write-only property contact_address to the response with the 200 status (media type: application/xml; version=2.4.12)

      response-optional-write-only-property-added

    • added the optional write-only property contact_address_external_id to the response with the 200 status (media type: application/json; version=2.4.12)

      response-optional-write-only-property-added

    • added the optional write-only property contact_address_external_id to the response with the 200 status (media type: application/xml; version=2.4.12)

      response-optional-write-only-property-added

    • added the new optional query request parameter order__orderer__company

      new-optional-request-parameter

    • added the new optional query request parameter order__orderer__company__icontains

      new-optional-request-parameter

    • added the new optional query request parameter order__orderer__company__iexact

      new-optional-request-parameter

    • added the new optional query request parameter order__orderer__company__istartswith

      new-optional-request-parameter

    • added the new optional query request parameter order__orderer__emails__contained_by

      new-optional-request-parameter

    • added the new optional query request parameter order__orderer__emails__contains

      new-optional-request-parameter

    • added the new optional query request parameter order__orderer__emails__overlap

      new-optional-request-parameter

    • added the new optional query request parameter order__orderer__name

      new-optional-request-parameter

    • added the new optional query request parameter order__orderer__name__icontains

      new-optional-request-parameter

    • added the new optional query request parameter order__orderer__name__iexact

      new-optional-request-parameter

    • added the new optional query request parameter order__orderer__name__istartswith

      new-optional-request-parameter

    • added the new optional query request parameter order__orderer__notes

      new-optional-request-parameter

    • added the new optional query request parameter order__orderer__notes__icontains

      new-optional-request-parameter

    • added the new optional query request parameter order__orderer__notes__iexact

      new-optional-request-parameter

    • added the new optional query request parameter order__orderer__notes__istartswith

      new-optional-request-parameter

    • added the new optional query request parameter order__orderer__phones__contained_by

      new-optional-request-parameter

    • added the new optional query request parameter order__orderer__phones__contains

      new-optional-request-parameter

    • added the new optional query request parameter order__orderer__phones__overlap

      new-optional-request-parameter

    • media type application/json; version=2.4.10 was changed to application/json; version=2.4.11 for the response status 200

      response-media-type-name-changed

    • media type application/xml; version=2.4.10 was changed to application/xml; version=2.4.11 for the response status 200

      response-media-type-name-changed

    • media type application/json; version=2.4.5 was changed to application/json; version=2.4.10 for the response status 200

      response-media-type-name-changed

    • media type application/xml; version=2.4.5 was changed to application/xml; version=2.4.10 for the response status 200

      response-media-type-name-changed

    • media type application/json; version=2.3.5 was changed to application/json; version=2.4.5 for the response status 200

      response-media-type-name-changed

    • media type application/xml; version=2.3.5 was changed to application/xml; version=2.4.5 for the response status 200

      response-media-type-name-changed

    • added the required property trackers to the response with the 200 status (media type: application/json; version=2.4.5)

      response-required-property-added

    • added the required property trackers to the response with the 200 status (media type: application/xml; version=2.4.5)

      response-required-property-added

  • 8446ece0e1484228See the full diff
    • the request property address became required (media type: application/json)

      request-property-became-required

    • the request property address became required (media type: application/xml)

      request-property-became-required

    • removed the required property trackers from the response with the 200 status (media type: application/json; version=2.3.5)

      response-required-property-removed

    • removed the required property trackers from the response with the 200 status (media type: application/xml; version=2.3.5)

      response-required-property-removed

    • deleted the query request parameter order__orderer__company

      request-parameter-removed

    • deleted the query request parameter order__orderer__company__icontains

      request-parameter-removed

    • deleted the query request parameter order__orderer__company__iexact

      request-parameter-removed

    • deleted the query request parameter order__orderer__company__istartswith

      request-parameter-removed

    • deleted the query request parameter order__orderer__emails__contained_by

      request-parameter-removed

    • deleted the query request parameter order__orderer__emails__contains

      request-parameter-removed

    • deleted the query request parameter order__orderer__emails__overlap

      request-parameter-removed

    • deleted the query request parameter order__orderer__name

      request-parameter-removed

    • deleted the query request parameter order__orderer__name__icontains

      request-parameter-removed

    • deleted the query request parameter order__orderer__name__iexact

      request-parameter-removed

    • deleted the query request parameter order__orderer__name__istartswith

      request-parameter-removed

    • deleted the query request parameter order__orderer__notes

      request-parameter-removed

    • deleted the query request parameter order__orderer__notes__icontains

      request-parameter-removed

    • deleted the query request parameter order__orderer__notes__iexact

      request-parameter-removed

    • deleted the query request parameter order__orderer__notes__istartswith

      request-parameter-removed

    • deleted the query request parameter order__orderer__phones__contained_by

      request-parameter-removed

    • deleted the query request parameter order__orderer__phones__contains

      request-parameter-removed

    • deleted the query request parameter order__orderer__phones__overlap

      request-parameter-removed

    • removed the request property contact_address (media type: application/json)

      request-property-removed

    • removed the request property contact_address (media type: application/xml)

      request-property-removed

    • removed the request property contact_address_external_id (media type: application/json)

      request-property-removed

    • removed the request property contact_address_external_id (media type: application/xml)

      request-property-removed

    • media type application/json; version=2.4.13 was changed to application/json; version=2.3.5 for the response status 200

      response-media-type-name-changed

    • media type application/xml; version=2.4.13 was changed to application/xml; version=2.3.5 for the response status 200

      response-media-type-name-changed

    • removed the optional write-only property contact_address from the response with the 200 status (media type: application/json; version=2.3.5)

      response-optional-write-only-property-removed

    • removed the optional write-only property contact_address from the response with the 200 status (media type: application/xml; version=2.3.5)

      response-optional-write-only-property-removed

    • removed the optional write-only property contact_address_external_id from the response with the 200 status (media type: application/json; version=2.3.5)

      response-optional-write-only-property-removed

    • removed the optional write-only property contact_address_external_id from the response with the 200 status (media type: application/xml; version=2.3.5)

      response-optional-write-only-property-removed

    • the response property address became required for the status 200 (media type: application/json; version=2.3.5)

      response-property-became-required

    • the response property address became required for the status 200 (media type: application/xml; version=2.3.5)

      response-property-became-required

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog