NameDescriptionTypeAdditional information
shipment_company_id

string

Required

shipment_id

Filter shipment by id. 0 = All Shipments or INT shipment id.

integer

None.

shipment_state

0 = All Shipments | 1000 = Pending Offer | 2000 = Pending driver approval | 3000 = Pending Payment | 4000 = Pending driver departure approval | 5000 = In Transit | 6000 = Pending user arrival approval | 6400 = Missing document | 6500 = Problem transport | 7000 = Pending company arrival approval | 10000 = Completed.

integer

None.

shipment_custom_id

Filter shipment custom id. null = All item .

string

None.

departure_address_id

Filter shipment departure address id. null = All item .

integer

None.

departure_date_begin

Filter shipment departure date begin. null = All item .

date

None.

departure_date_end

Filter shipment departure date end. null = All item .

date

None.

arrival_address_id

Filter shipment arrival address id. null = All item .

integer

None.

arrival_date_begin

Filter shipment arrival date begin. null = All item .

date

None.

arrival_date_end

Filter shipment arrival date end. null = All item .

date

None.

amount_begin

Filter shipment amount begin. null = All item .

decimal number

None.

amount_end

Filter shipment amount end. null = All item .

decimal number

None.

distance_begin

Filter shipment distance begin. null = All item .

integer

None.

distance_end

Filter shipment distance end. null = All item .

integer

None.

driver_user_id

Filter shipment driver user id. null = All item .

string

None.

vehicle_licence_plate

Filter shipment vehicle licence plate. null = All item .

string

None.

destination_count

Filter shipment destination count. null = All item .

integer

None.

page_number

Filter shipments pagination. Start page : 1

integer

None.

page_length

Filter shipments page item count.

integer

None.

order

Filter shipments order types : shipment_inc_id,departure_date,arrival_date,amount,distance

string

None.

order_asc

Filter shipments order ASC : true | DESC : false

boolean

None.

user_id

User ID (GUID)

string

Required

Data type: Text

user_signature

MD5 hash signature for the active user to validate the request

string

Required

Data type: Text