Search
K
Fulfillment API

ListingIdSearchRequest

object

Search listing IDs information.

opstring

The operation type for the listing IDs. Values: EQ, NEQ, RANGE.

Example:EQ

valuesarray[string]

A collection of listing ID values.

Example:42220470, 157a16f0-503d-4256-ba60-a4876e8eb9bb

Example

NoteCollection

object

A collection of notes.

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/notes

countinteger(int32)

The total count of resources in the collection.

Example:23

itemsarray[object]

Details of an internal load note.

Show Child Parameters
Example

NoteResponse

object

Details of an internal load note.

noteIdstring(uuid)

The ID of the note.

Example:3fde6068-5fa2-4ae4-af16-06d65fc87dc9

dispatchIdstring(uuid)

The ID of the dispatch.

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

customerIdstring(uuid)

The Central Dispatch customer ID of the customer.

Example:d5c62b14-cbd1-11ee-9a0e-0242ac110002

profileTypestring

The profile type of the note author.

Example:CARRIER

loadTypestring

The load type associated with the note.

Example:STANDARD

displayNamestring

The display name of the note author.

Example:Mickey Smith

messagestring

The content of the note.

Example:Carrier called - pickup rescheduled for tomorrow.

createdDateUtcstring(date-time)

The creation date and time of the item, in UTC/ISO 8601 format.

Example:2024-10-31T00:00:00Z

createdBystring(uuid)

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

visibilityTypestring

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

Example:INTERNAL

noteSourcestring

The source of the note.

Example:WEB

Example

PriceRequest

object

Details of the dispatch price.

totalPricenumber(double)

The total amount to be paid for completing the dispatch.

>= 0.01

Example:500

priceUnitsstring

The currency of totalPrice.

Default:USD

Example:USD

Example

RespondToDispatchRequest

object

Details of the respond request.

acceptboolean

Indicates whether the dispatch should be accepted or declined.

Example:true

inspectionAcknowledgedboolean

Indicates whether the require inspection requirement was acknoowledged.

Default:false

Example:true

carrierEstimatedPickupDatestring(date-time)

The date the carrier estimates the vehicle will be picked up, in UTC/ISO 8601 format. Only the date portion of the value passed will be saved.

Example:2025-07-15T00:00:00.000Z

carrierEstimatedDeliveryDatestring(date-time)

The type of delivery date. Only the date portion of the value passed will be saved.

Example:2025-08-15T00:00:00.000Z

Example