Appointment Query

currentPage

integer

false

none

none

pageSize

integer

false

none

none

sortingFields

[SortingField]

false

none

none

appointmentId

string

false

none

Specific appointment identifier

appointmentIds

[string]

false

none

List of appointment identifiers for batch query

appointmentType

string

false

none

Appointment type filter

appointmentTypes

[string]

false

none

List of appointment types for batch query

carrierId

string

false

none

Carrier identifier filter

carrierIds

[string]

false

none

List of carrier identifiers for batch query

serviceTypes

[string]

false

none

List of service types for filtering

appointmentTimePeriod

[string]

false

none

Appointment time range for filtering

appointmentTimeStart

string

false

none

Appointment time start

appointmentTimeEnd

string

false

none

Appointment time end

appointmentStatus

string

false

none

Appointment status

excludeAppointmentStatus

string

false

none

Appointment exclude status

excludeAppointmentStatuses

[string]

false

none

Appointment exclude statuses

appointmentStatuses

[string]

false

none

List of appointment statuses

customerIds

[string]

false

none

List of customer identifiers

customerId

string

false

none

Single customer identifier

externalId

integer(int64)

false

none

External system identifier

entryId

string

false

none

Entry ticket identifier

entryIds

[string]

false

none

List of entry ticket identifiers

referenceCode

string

false

none

Reference code for check-in binding

referenceNo

string

false

none

Reference number

driverId

string

false

none

Driver identifier

driverIds

[string]

false

none

Driver identifier

receiptId

string

false

none

Receipt identifier

loadId

string

false

none

Load identifier

loadNo

string

false

none

Load number

masterBol

string

false

none

Master bill of lading number

poNo

string

false

none

Purchase order number

orderId

string

false

none

Order identifier

keyword

string

false

none

Keyword for fuzzy search on referenceIds

createdTimePeriod

[string]

false

none

Appointment time range for filtering

reason

string

false

none

Appointment change reason

loadIds

string

false

none

Load identifier

appointmentType

INBOUND

appointmentType

OUTBOUND

appointmentType

BOTH

appointmentStatus

NEW

appointmentStatus

CANCELED

appointmentStatus

NOT_CONFIRMED

appointmentStatus

PENDING_DISPATCH

appointmentStatus

WAITINGFORDRIVER

appointmentStatus

PRECHECKIN_COMPLETE

appointmentStatus

CHECKED_IN

excludeAppointmentStatus

NEW

excludeAppointmentStatus

CANCELED

excludeAppointmentStatus

NOT_CONFIRMED

excludeAppointmentStatus

PENDING_DISPATCH

excludeAppointmentStatus

WAITINGFORDRIVER

excludeAppointmentStatus

PRECHECKIN_COMPLETE

excludeAppointmentStatus

CHECKED_IN