POST v1/company/shipment/offerRequest

WEB - Request offers for a company shipment from a list of drivers

Request Information

URI Parameters

None.

Body Parameters

ShipmentOfferRequestModel
NameDescriptionTypeAdditional information
shipment_id

GUID of an existing shipment of the company

string

Required

offer_amount_fixed

Specifies whether the transportation price is fixed or the price can be modified for the offer

boolean

None.

drivers

List of drivers to request offers from

Collection of DriverUserAndVehicle

Required

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_id": "sample string 1",
  "offer_amount_fixed": true,
  "drivers": [
    {
      "driver_user_id": "sample string 1",
      "driver_vehicle_id": 2
    },
    {
      "driver_user_id": "sample string 1",
      "driver_vehicle_id": 2
    }
  ],
  "user_company_id": "sample string 3",
  "user_id": "sample string 4",
  "user_signature": "sample string 5"
}

Response Information

Resource Description

WEB - Request offers for a company shipment from a list of drivers

BaseMetaResultModelOfShipmentOfferResponseModel
NameDescriptionTypeAdditional information
response

ShipmentOfferResponseModel

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": {
    "offer_requests": [
      {
        "sor_id": 1,
        "sor_company_id": "sample string 2",
        "sor_user_id": "sample string 3",
        "sor_shipment_id": "sample string 4",
        "sor_vehicle_id": 5,
        "sor_amount": 1,
        "sor_amount_fixed": true,
        "sor_request_time": "2018-05-21T12:19:42.1361882+03:00",
        "sor_response_time": "2018-05-21T12:19:42.1361882+03:00",
        "sor_has_response": true,
        "sor_accepted": true,
        "company_name": "sample string 10",
        "shipment_departure_address_id": 1,
        "shipment_destination_address_id": 1,
        "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",
          "address_location": {
            "latitude": "sample string 1",
            "longitude": "sample string 2"
          },
          "address_zip_code": "sample string 19",
          "address_is_active": true,
          "departure_bill_date": "2018-05-21T12:19:42.1361882+03:00",
          "delivery_bill_date": "2018-05-21T12:19:42.1361882+03:00",
          "destination_entry_date": "2018-05-21T12:19:42.1361882+03:00",
          "destination_exit_date": "2018-05-21T12:19:42.1361882+03:00"
        },
        "destination_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",
          "address_location": {
            "latitude": "sample string 1",
            "longitude": "sample string 2"
          },
          "address_zip_code": "sample string 19",
          "address_is_active": true,
          "departure_bill_date": "2018-05-21T12:19:42.1361882+03:00",
          "delivery_bill_date": "2018-05-21T12:19:42.1361882+03:00",
          "destination_entry_date": "2018-05-21T12:19:42.1361882+03:00",
          "destination_exit_date": "2018-05-21T12:19:42.1361882+03:00"
        },
        "shipment_departure_date": "2018-05-21T12:19:42.1361882+03:00",
        "shipment_arrival_date": "2018-05-21T12:19:42.1361882+03:00"
      },
      {
        "sor_id": 1,
        "sor_company_id": "sample string 2",
        "sor_user_id": "sample string 3",
        "sor_shipment_id": "sample string 4",
        "sor_vehicle_id": 5,
        "sor_amount": 1,
        "sor_amount_fixed": true,
        "sor_request_time": "2018-05-21T12:19:42.1361882+03:00",
        "sor_response_time": "2018-05-21T12:19:42.1361882+03:00",
        "sor_has_response": true,
        "sor_accepted": true,
        "company_name": "sample string 10",
        "shipment_departure_address_id": 1,
        "shipment_destination_address_id": 1,
        "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",
          "address_location": {
            "latitude": "sample string 1",
            "longitude": "sample string 2"
          },
          "address_zip_code": "sample string 19",
          "address_is_active": true,
          "departure_bill_date": "2018-05-21T12:19:42.1361882+03:00",
          "delivery_bill_date": "2018-05-21T12:19:42.1361882+03:00",
          "destination_entry_date": "2018-05-21T12:19:42.1361882+03:00",
          "destination_exit_date": "2018-05-21T12:19:42.1361882+03:00"
        },
        "destination_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",
          "address_location": {
            "latitude": "sample string 1",
            "longitude": "sample string 2"
          },
          "address_zip_code": "sample string 19",
          "address_is_active": true,
          "departure_bill_date": "2018-05-21T12:19:42.1361882+03:00",
          "delivery_bill_date": "2018-05-21T12:19:42.1361882+03:00",
          "destination_entry_date": "2018-05-21T12:19:42.1361882+03:00",
          "destination_exit_date": "2018-05-21T12:19:42.1361882+03:00"
        },
        "shipment_departure_date": "2018-05-21T12:19:42.1361882+03:00",
        "shipment_arrival_date": "2018-05-21T12:19:42.1361882+03:00"
      }
    ]
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}