POST v1/company/shipment/offer

WEB - LIST OFFERS. To get offers for a shipment.

Request Information

URI Parameters

None.

Body Parameters

ShipmentListOfferRequestModel
NameDescriptionTypeAdditional information
shipment_id

string

Required

Data type: Text

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",
  "user_company_id": "sample string 2",
  "user_id": "sample string 3",
  "user_signature": "sample string 4"
}

Response Information

Resource Description

WEB - LIST OFFERS. To get offers for a shipment.

ShipmentListOfferResultModel
NameDescriptionTypeAdditional information
response

ShipmentListOffersResponseModel

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": {
    "offers": [
      {
        "offer_id": 1,
        "offer_amount": 2,
        "offer_date_time": "sample string 3",
        "offer_accepted": true,
        "offer_user_declined": true,
        "user": {
          "user_id": 1,
          "user_uid": "sample string 2",
          "user_first_name": "sample string 3",
          "user_image": "sample string 4",
          "user_rating": 5
        },
        "vehicle": {
          "vehicle_id": 1,
          "vehicle_type": "sample string 2",
          "vehicle_licence_plate": "sample string 3",
          "vehicle_brand": "sample string 4",
          "vehicle_image": "sample string 5",
          "vehicle_year": "sample string 6",
          "vehicle_max_capacity": "sample string 7",
          "vehicle_approved": true
        }
      },
      {
        "offer_id": 1,
        "offer_amount": 2,
        "offer_date_time": "sample string 3",
        "offer_accepted": true,
        "offer_user_declined": true,
        "user": {
          "user_id": 1,
          "user_uid": "sample string 2",
          "user_first_name": "sample string 3",
          "user_image": "sample string 4",
          "user_rating": 5
        },
        "vehicle": {
          "vehicle_id": 1,
          "vehicle_type": "sample string 2",
          "vehicle_licence_plate": "sample string 3",
          "vehicle_brand": "sample string 4",
          "vehicle_image": "sample string 5",
          "vehicle_year": "sample string 6",
          "vehicle_max_capacity": "sample string 7",
          "vehicle_approved": true
        }
      }
    ]
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}