Search
K
Fulfillment API

CreateNoteRequest

object

Details of a note.

dispatchIdstring(uuid)

The ID of the dispatch.

Example:d159acc0-e89b-12d3-a456-426614174000

messagestring

The content of the note.

Example:Carrier called - pickup rescheduled for tomorrow.

visibilityTypestring

The visibility type of the note. Allowed values: INTERNAL. Defaults to INTERNAL if not provided.

Example:INTERNAL

Example

DateChangeReasonCollection

object

Details of a collection of items with ID and Name pairs.

itemsarray[object]

Details of the date change reason.

Show Child Parameters
Example

DateChangeReasonResponse

object

Details of the date change reason.

idstring(uuid)

The ID of the date change reason.

Example:da1e0000-e89b-12d3-a456-426614174000

namestring

The name of the date change reason.

Example:Mechanical issues with carrier's truck

Example

DateSearchRequest

object

Search dispatch date request.

opstring

The operation type for the date comparison. Values: RANGE, EQ, NEQ.

Example:RANGE

startDateTimestring(date-time)

The start date and time, in UTC/ISO 8601 format.

endDateTimestring(date-time)

The end date and time, in UTC/ISO 8601 format. Required for RANGE and must be equal or greater than startDateTime.

Example

DispatchCollection

object

A collection of dispatches.

hrefstring

The URL used to query the current collection of the resource.

Example:https://fulfillment-api.centraldispatch.com/api/fulfillments/id/d159acc0-e89b-12d3-a456-426614174000

countinteger(int32)

The total count of resources in the collection.

Example:23

itemsarray[object]

Details of a dispatch.

Show Child Parameters
Example