POST v1/admin/shipment/listByCompany
ADMIN - Returns the list of shipments of a company filterable by an optional company specific custom ID.
Request Information
URI Parameters
None.
Body Parameters
AdminGetShipmentsByCompanyRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| shipment_company_id |
Company UID to return all shipments |
string |
None. |
| 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_states | Collection of integer |
None. |
|
| shipment_custom_id |
Optional company specific custom ID to limit the shipment listing |
string |
Max length: 100 |
| departure_address_id | 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. |
| company_name | string |
None. |
|
| user_first_name | string |
None. |
|
| shipment_departure_address_name | string |
None. |
|
| shipment_departure_date | date |
None. |
|
| shipment_destination_address_name | string |
None. |
|
| shipment_destination_date | date |
None. |
|
| shipment_proposal_cost | integer |
None. |
|
| shipment_offer_count | integer |
None. |
|
| shipment_distance | integer |
None. |
|
| shipment_destination_count | integer |
None. |
|
| shipment_visit_count | integer |
None. |
|
| user_company_id |
Company UID of the active user |
string |
Required Data type: Text |
| 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 |
Request Format
application/json, text/json
Sample:
{
"shipment_company_id": "sample string 1",
"shipment_id": 2,
"shipment_state": 3,
"shipment_states": [
1,
2
],
"shipment_custom_id": "sample string 4",
"departure_address_id": 1,
"departure_date_begin": "2024-11-25T22:56:57.0378294+03:00",
"departure_date_end": "2024-11-25T22:56:57.0378294+03:00",
"arrival_address_id": 1,
"arrival_date_begin": "2024-11-25T22:56:57.0378294+03:00",
"arrival_date_end": "2024-11-25T22:56:57.0378294+03:00",
"amount_begin": 1.1,
"amount_end": 1.1,
"distance_begin": 1,
"distance_end": 1,
"driver_user_id": "sample string 5",
"vehicle_licence_plate": "sample string 6",
"destination_count": 1,
"page_number": 7,
"page_length": 8,
"order": "sample string 9",
"order_asc": true,
"company_name": "sample string 11",
"user_first_name": "sample string 12",
"shipment_departure_address_name": "sample string 13",
"shipment_departure_date": "2024-11-25T22:56:57.0378294+03:00",
"shipment_destination_address_name": "sample string 14",
"shipment_destination_date": "2024-11-25T22:56:57.0378294+03:00",
"shipment_proposal_cost": 1,
"shipment_offer_count": 1,
"shipment_distance": 1,
"shipment_destination_count": 1,
"shipment_visit_count": 1,
"user_company_id": "sample string 15",
"user_id": "sample string 16",
"user_signature": "sample string 17"
}
Response Information
Resource Description
ADMIN - Returns the list of shipments of a company filterable by an optional company specific custom ID.
ShipmentListResult| Name | Description | Type | Additional information |
|---|---|---|---|
| response | ShipmentsModel |
None. |
|
| meta |
Basic meta information for the operation result |
MetaModel |
None. |
Response Format
application/json, text/json
Sample:
{
"response": {
"shipments": [
null,
{
"shipment_id": 1,
"shipment_uid": "sample string 2",
"shipment_company_id": "sample string 3",
"company_name": "sample string 4",
"shipment_customer_id": "sample string 5",
"shipment_group_id": "sample string 6",
"shipment_shape_type_id": "sample string 7",
"shipment_shape_type_type_id": "sample string 8",
"shipment_type_id": "sample string 9",
"shipment_vehicle_type_id": "sample string 10",
"shipment_pallet_count": 1,
"shipment_vehicle_trailer_type_id": "sample string 11",
"shipment_vehicle_trailer_type_ids": [
{
"shipment_vehicle_trailer_type_id": 1
},
{
"shipment_vehicle_trailer_type_id": 1
}
],
"shipment_vehicle_base_slab_id": "sample string 12",
"shipment_vehicle_capacity_type_id": "sample string 13",
"shipment_payment_type_id": 1,
"shipment_departure_date": "2024-11-25T22:56:57.0428299+03:00",
"shipment_departure_address_id": 15,
"shipment_distance": 1.0,
"shipment_proposal_cost": "sample string 16",
"shipment_proposal_currency_id": 17,
"shipment_proposal_cost_per_ton": 18,
"shipment_accepted_cost": 1,
"shipment_cubic_meter": "sample string 19",
"shipment_weight": "sample string 20",
"shipment_length": "sample string 21",
"shipment_remark": "sample string 22",
"shipment_state": 1,
"shipment_accepted_offer_id": 1,
"shipment_freight_delivery_invoice": "sample string 23",
"shipment_custom_id": "sample string 24",
"shipment_offer_count": 1,
"shipment_latitude": 1.1,
"shipment_longitude": 1.1,
"shipment_date_time": "2024-11-25T22:56:57.0428299+03:00",
"shipment_has_problem": true,
"shipment_departure_address": {
"address_id": 1,
"address_stop_id": "sample string 2",
"address_name": "sample string 3",
"address_country_id": 5,
"address_city_id": 6,
"address_city_name": "sample string 7",
"address_district": "sample string 8",
"address_neighborhood": "sample string 9",
"address_street": "sample string 10",
"address_building_number": "sample string 11",
"address_contact_name": "sample string 12",
"address_contact_phone_number": "sample string 13",
"address_arrival_date": "sample string 14",
"shipment_freight_departure_bill": "sample string 15",
"shipment_freight_delivery_bill": "sample string 16",
"shipment_freight_delivery_bill_missing": true,
"location_latitude": "sample string 1",
"location_longitude": "sample string 2",
"address_location": {
"latitude": "sample string 1",
"longitude": "sample string 2"
},
"address_zip_code": "sample string 19",
"address_is_active": true,
"shipment_freight_waybill_no": "sample string 21",
"departure_bill_date": "2024-11-25T22:56:57.0428299+03:00",
"delivery_bill_date": "2024-11-25T22:56:57.0428299+03:00",
"destination_entry_date": "2024-11-25T22:56:57.0428299+03:00",
"destination_exit_date": "2024-11-25T22:56:57.0428299+03:00",
"driver_arrival_address_time_spent": 1,
"address_description": "sample string 22",
"address_create_date": "2024-11-25T22:56:57.0428299+03:00",
"address_user_name": "sample string 23",
"shipment_freight_delivery_no": "sample string 24",
"required_documents": [
{
"required_document": {
"id": 1,
"name": "sample string 2",
"type": 3
},
"document": {
"id": 1,
"image": "sample string 2",
"type": 3
}
},
{
"required_document": {
"id": 1,
"name": "sample string 2",
"type": 3
},
"document": {
"id": 1,
"image": "sample string 2",
"type": 3
}
}
],
"address_external_id": "sample string 25",
"shipment_stop_pallet_count": 1,
"shipment_stop_cubic_meter": 1.0,
"shipment_stop_weight": 1.0
},
"shipment_destinations": [
{
"address_id": 1,
"address_stop_id": "sample string 2",
"address_name": "sample string 3",
"address_country_id": 5,
"address_city_id": 6,
"address_city_name": "sample string 7",
"address_district": "sample string 8",
"address_neighborhood": "sample string 9",
"address_street": "sample string 10",
"address_building_number": "sample string 11",
"address_contact_name": "sample string 12",
"address_contact_phone_number": "sample string 13",
"address_arrival_date": "sample string 14",
"shipment_freight_departure_bill": "sample string 15",
"shipment_freight_delivery_bill": "sample string 16",
"shipment_freight_delivery_bill_missing": true,
"location_latitude": "sample string 1",
"location_longitude": "sample string 2",
"address_location": {
"latitude": "sample string 1",
"longitude": "sample string 2"
},
"address_zip_code": "sample string 19",
"address_is_active": true,
"shipment_freight_waybill_no": "sample string 21",
"departure_bill_date": "2024-11-25T22:56:57.0428299+03:00",
"delivery_bill_date": "2024-11-25T22:56:57.0428299+03:00",
"destination_entry_date": "2024-11-25T22:56:57.0428299+03:00",
"destination_exit_date": "2024-11-25T22:56:57.0428299+03:00",
"driver_arrival_address_time_spent": 1,
"address_description": "sample string 22",
"address_create_date": "2024-11-25T22:56:57.0428299+03:00",
"address_user_name": "sample string 23",
"shipment_freight_delivery_no": "sample string 24",
"required_documents": [
{
"required_document": {
"id": 1,
"name": "sample string 2",
"type": 3
},
"document": {
"id": 1,
"image": "sample string 2",
"type": 3
}
},
{
"required_document": {
"id": 1,
"name": "sample string 2",
"type": 3
},
"document": {
"id": 1,
"image": "sample string 2",
"type": 3
}
}
],
"address_external_id": "sample string 25",
"shipment_stop_pallet_count": 1,
"shipment_stop_cubic_meter": 1.0,
"shipment_stop_weight": 1.0
},
{
"address_id": 1,
"address_stop_id": "sample string 2",
"address_name": "sample string 3",
"address_country_id": 5,
"address_city_id": 6,
"address_city_name": "sample string 7",
"address_district": "sample string 8",
"address_neighborhood": "sample string 9",
"address_street": "sample string 10",
"address_building_number": "sample string 11",
"address_contact_name": "sample string 12",
"address_contact_phone_number": "sample string 13",
"address_arrival_date": "sample string 14",
"shipment_freight_departure_bill": "sample string 15",
"shipment_freight_delivery_bill": "sample string 16",
"shipment_freight_delivery_bill_missing": true,
"location_latitude": "sample string 1",
"location_longitude": "sample string 2",
"address_location": {
"latitude": "sample string 1",
"longitude": "sample string 2"
},
"address_zip_code": "sample string 19",
"address_is_active": true,
"shipment_freight_waybill_no": "sample string 21",
"departure_bill_date": "2024-11-25T22:56:57.0428299+03:00",
"delivery_bill_date": "2024-11-25T22:56:57.0428299+03:00",
"destination_entry_date": "2024-11-25T22:56:57.0428299+03:00",
"destination_exit_date": "2024-11-25T22:56:57.0428299+03:00",
"driver_arrival_address_time_spent": 1,
"address_description": "sample string 22",
"address_create_date": "2024-11-25T22:56:57.0428299+03:00",
"address_user_name": "sample string 23",
"shipment_freight_delivery_no": "sample string 24",
"required_documents": [
{
"required_document": {
"id": 1,
"name": "sample string 2",
"type": 3
},
"document": {
"id": 1,
"image": "sample string 2",
"type": 3
}
},
{
"required_document": {
"id": 1,
"name": "sample string 2",
"type": 3
},
"document": {
"id": 1,
"image": "sample string 2",
"type": 3
}
}
],
"address_external_id": "sample string 25",
"shipment_stop_pallet_count": 1,
"shipment_stop_cubic_meter": 1.0,
"shipment_stop_weight": 1.0
}
],
"shipment_temperature": 26,
"offer_confirmation_company_user_name": "sample string 27",
"shipment_has_adr": true,
"shipment_is_unpriced": true,
"shipment_state_reason": 1,
"shipment_departure_contact_name": "sample string 30",
"shipment_departure_contact_phone_number": "sample string 31",
"shipment_has_blank_load": true,
"shipment_state_update_user_name": "sample string 32",
"shipment_company_user_id": "sample string 33",
"shipment_archived": true,
"shipment_freight_departure_bill_missing": true,
"shipment_departure_address_arrival_date": "2024-11-25T22:56:57.0428299+03:00",
"user_last_location_time": "2024-11-25T22:56:57.0428299+03:00",
"shipment_driver_departure_address_time_spent": 1,
"shipment_departure_address_json": "",
"shipment_destinations_address_json": "",
"shipment_actual_arrival_date": null,
"shipment_accept_user_id": null,
"vehicle_licence_plate": null,
"user_first_name": null,
"shipment_company_user_name": null,
"shipment_visit_count": 0,
"shipment_parent_company_name": null,
"vehicle_company_user_name": null,
"vehicle_create_date": null,
"shipment_arrival_date": null,
"shipment_departure_document_date": null,
"shipment_arrival_document_date": null,
"user_cell_number": null,
"user_viewed_shipment": false,
"shipment_company_user_role_name": null,
"arrival_address_city_id": 0,
"shipment_payment_cost": null,
"shipment_tirport_payment_is_active": false,
"shipment_tirport_payment_is_completed": false,
"shipment_departure_stop_pallet_count": null,
"shipment_departure_stop_cubic_meter": null,
"shipment_departure_stop_weight": null
}
],
"total_count": 1,
"shipments_with_missing_documents": [
"sample string 1",
"sample string 2"
]
},
"meta": {
"status_code": 1,
"status_message": "sample string 2"
}
}