POST v1/admin/shipment/offer/request/list

ADMIN - Shipment get offer request.

Request Information

URI Parameters

None.

Body Parameters

CompanyOfferRequestListRequestModel
NameDescriptionTypeAdditional information
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:
{
  "user_company_id": "sample string 1",
  "user_id": "sample string 2",
  "user_signature": "sample string 3"
}

Response Information

Resource Description

ADMIN - Shipment get offer request.

BaseMetaResultModelOfListOfShipmentOfferRequestModel
NameDescriptionTypeAdditional information
response

Collection of ShipmentOfferRequestModel

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": [
    {
      "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"
    },
    {
      "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"
    }
  ],
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}