POST v1/admin/shipment/summary-list

ADMIN - Returns the list of shipments of a company filterable by an optional company specific custom ID.

Request Information

URI Parameters

None.

Body Parameters

AdminGetShipmentsSummaryByCompanyRequestModel

Name	Description	Type	Additional information
shipment_company_id	Company UID to return all shipments	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	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.
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_custom_id": "sample string 4",
  "departure_address_id": 1,
  "departure_date_begin": "2024-11-25T20:42:40.6400847+03:00",
  "departure_date_end": "2024-11-25T20:42:40.6400847+03:00",
  "arrival_address_id": 1,
  "arrival_date_begin": "2024-11-25T20:42:40.6400847+03:00",
  "arrival_date_end": "2024-11-25T20:42:40.6400847+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,
  "user_company_id": "sample string 11",
  "user_id": "sample string 12",
  "user_signature": "sample string 13"
}

Response Information

Resource Description

ADMIN - Returns the list of shipments of a company filterable by an optional company specific custom ID.

BaseMetaResultModelOfListOfAdminGetShipmentsByCompanyResponseModel

Name	Description	Type	Additional information
response		Collection of AdminGetShipmentsByCompanyResponseModel	None.
meta	Basic meta information for the operation result	MetaModel	None.

Response Format

application/json, text/json

Sample:

{
  "response": [
    {
      "shipment_id": "sample string 1",
      "shipment_inc_id": 2,
      "shipment_company_id": "sample string 3",
      "shipment_company_user": "sample string 4",
      "shipment_driver_name": "sample string 5",
      "shipment_vehicle_licence_plate": "sample string 6",
      "shipment_departure_address": "sample string 7",
      "shipment_departure_date": "sample string 8",
      "shipment_state": "sample string 9",
      "shipment_arrival_date": "sample string 10",
      "shipment_arrival_address": "sample string 11",
      "shipment_date_time": "sample string 12",
      "shipment_custom_id": "sample string 13",
      "shipment_stop_count": 14
    },
    {
      "shipment_id": "sample string 1",
      "shipment_inc_id": 2,
      "shipment_company_id": "sample string 3",
      "shipment_company_user": "sample string 4",
      "shipment_driver_name": "sample string 5",
      "shipment_vehicle_licence_plate": "sample string 6",
      "shipment_departure_address": "sample string 7",
      "shipment_departure_date": "sample string 8",
      "shipment_state": "sample string 9",
      "shipment_arrival_date": "sample string 10",
      "shipment_arrival_address": "sample string 11",
      "shipment_date_time": "sample string 12",
      "shipment_custom_id": "sample string 13",
      "shipment_stop_count": 14
    }
  ],
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}