ErrorsAlt
objectAn error occurred, and the request could not be completed.
Details of an error or issue.
Show Child Parameters
EventType
The event type. This list is not exhaustive and additional values may be added at any time.
Allowed values:PICKED_UPIN_TRANSITDELIVERED
ListingIdSearchRequest
objectSearch listing IDs information.
The operation type for the listing IDs. Values: EQ, NEQ, RANGE.
Example:EQ
A collection of listing ID values.
Example:42220470, 157a16f0-503d-4256-ba60-a4876e8eb9bb
NoteCollection
objectA collection of notes.
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/notes
The total count of resources in the collection.
Example:23
Details of an internal load note.
Show Child Parameters
NoteResponse
objectDetails of an internal load note.
The ID of the note.
Example:3fde6068-5fa2-4ae4-af16-06d65fc87dc9
The ID of the dispatch.
Example:d159acc0-e89b-12d3-a456-426614174000
The Central Dispatch customer ID of the customer.
Example:d5c62b14-cbd1-11ee-9a0e-0242ac110002
The profile type of the note author.
Example:CARRIER
The load type associated with the note.
Example:STANDARD
The display name of the note author.
Example:Mickey Smith
The content of the note.
Example:Carrier called - pickup rescheduled for tomorrow.
The creation date and time of the item, in UTC/ISO 8601 format.
Example:2024-10-31T00:00:00Z
The Central Dispatch user ID of the user who created the note. Returns the user ID if the note was created by an authenticated end user, or the client ID if created via a TMS or client-credentials flow.
Example:d71b5750-e89b-12d3-a456-426614174000
The visibility type of the note. Allowed values: INTERNAL. Defaults to INTERNAL if not provided.
Example:INTERNAL
The source of the note.
Example:WEB