POST v1/admin/shipment/offerable-list
WEB - Offerable Shipment List
Request Information
URI Parameters
None.
Body Parameters
CompanyOfferableShipmentRequestListName | Description | Type | Additional information |
---|---|---|---|
shipment_vehicle_licence_plate | string |
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_vehicle_licence_plate": "sample string 1", "user_company_id": "sample string 2", "user_id": "sample string 3", "user_signature": "sample string 4" }
Response Information
Resource Description
WEB - Offerable Shipment List
BaseMetaResultModelOfListOfCompanyOfferableShipmentResponseModelName | Description | Type | Additional information |
---|---|---|---|
response | Collection of CompanyOfferableShipmentResponseModel |
None. |
|
meta |
Basic meta information for the operation result |
MetaModel |
None. |
Response Format
application/json, text/json
Sample:
{ "response": [ { "shipment_inc_id": 1, "shipment_id": "sample string 2", "shipment_company_name": "sample string 3", "shipment_vehicle_type_name": "sample string 4", "shipment_vehicle_trailer_types": "sample string 5", "shipment_departure_address": "sample string 6", "shipment_departure_date": "2024-11-25T22:45:18.4596788+03:00", "shipment_destination_address": "sample string 7", "shipment_arrival_date": "2024-11-25T22:45:18.4606788+03:00", "shipment_stop_addresses": "sample string 8", "shipment_proposal_cost": 9.0, "shipment_vehicle_suggestions": "sample string 10" }, { "shipment_inc_id": 1, "shipment_id": "sample string 2", "shipment_company_name": "sample string 3", "shipment_vehicle_type_name": "sample string 4", "shipment_vehicle_trailer_types": "sample string 5", "shipment_departure_address": "sample string 6", "shipment_departure_date": "2024-11-25T22:45:18.4596788+03:00", "shipment_destination_address": "sample string 7", "shipment_arrival_date": "2024-11-25T22:45:18.4606788+03:00", "shipment_stop_addresses": "sample string 8", "shipment_proposal_cost": 9.0, "shipment_vehicle_suggestions": "sample string 10" } ], "meta": { "status_code": 1, "status_message": "sample string 2" } }