Skip to main content
GET
Get all existing shipments (paginated)

Autorizaciones

Authorization
string
header
requerido

Use a valid JWT token in the Authorization header with the format 'Bearer {token}'

Parámetros de consulta

FilterBy
string

Format: Field[Operator]value. Combine conditions with && or ||; parentheses group conditions. Wrap the entire value in double quotes when it contains (, ), &&, or ||: Field[Operator]"whole value". Within a quoted value, the only supported escapes are " and \. Supported fields: CancelledAt, Code, CreatedAt, CreatedBy, Date, DeletedAt, Destination, DestinationId, ExternalReference, Id, LastModifiedAt, LastModifiedBy, LoadOrder.Name, LoadOrderId, Location.Name, LocationId, ShippedAt, Status, Type.

SortBy
string

Comma-separated field names. Prefix a field with - for descending order. Supported fields: CancelledAt, Code, CreatedAt, CreatedBy, Date, Destination, DestinationId, ExternalReference, Id, LastModifiedAt, LastModifiedBy, LoadOrder.Name, LoadOrderId, Location.Name, LocationId, ShippedAt, Status, Type.

Free-text search. Every word must partially match one of: Code, Destination, DestinationId, LoadOrder.Name, Location.Name.

Expand
enum<string>[]
Opciones disponibles:
Location,
LoadOrder,
LoadOrder.LoadLocation,
LoadOrder.Transport,
LoadOrder.Lines,
LoadOrder.ValidationEntries,
LoadOrder.TimeEntries
PageNumber
integer<int32>
PageSize
integer<int32>

Respuesta

OK

results
object[]
requerido
pageNumber
integer<int32>
requerido
totalPages
integer<int32>
requerido
totalCount
integer<int32>
requerido
pageSize
integer<int32>
requerido