POST v1/user/shipment/offer

MOBILE - Shipment get all offers.

Request Information

URI Parameters

None.

Body Parameters

UserOfferRequestModel
NameDescriptionTypeAdditional information
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_id": "sample string 1",
  "user_signature": "sample string 2"
}

Response Information

Resource Description

MOBILE - Shipment get all offers.

UserOfferResultModel
NameDescriptionTypeAdditional information
response

UserOfferResponseModel

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_user_declined": true,
        "company_address_city": "sample string 11",
        "company_address_district": "sample string 12",
        "company_address_neighborhood": "sample string 13",
        "company_address_street": "sample string 14",
        "company_address_zip_code": "sample string 15",
        "company_shipment_location_radius": 16,
        "licence_plate": "sample string 18"
      },
      {
        "offer_id": 1,
        "offer_amount": 2,
        "offer_date_time": "sample string 3",
        "offer_user_declined": true,
        "company_address_city": "sample string 11",
        "company_address_district": "sample string 12",
        "company_address_neighborhood": "sample string 13",
        "company_address_street": "sample string 14",
        "company_address_zip_code": "sample string 15",
        "company_shipment_location_radius": 16,
        "licence_plate": "sample string 18"
      }
    ],
    "offers_pending_driver": [
      {
        "offer_id": 1,
        "offer_amount": 2,
        "offer_date_time": "sample string 3",
        "offer_user_declined": true,
        "company_address_city": "sample string 11",
        "company_address_district": "sample string 12",
        "company_address_neighborhood": "sample string 13",
        "company_address_street": "sample string 14",
        "company_address_zip_code": "sample string 15",
        "company_shipment_location_radius": 16,
        "licence_plate": "sample string 18"
      },
      {
        "offer_id": 1,
        "offer_amount": 2,
        "offer_date_time": "sample string 3",
        "offer_user_declined": true,
        "company_address_city": "sample string 11",
        "company_address_district": "sample string 12",
        "company_address_neighborhood": "sample string 13",
        "company_address_street": "sample string 14",
        "company_address_zip_code": "sample string 15",
        "company_shipment_location_radius": 16,
        "licence_plate": "sample string 18"
      }
    ],
    "offers_pending_payment": [
      {
        "offer_id": 1,
        "offer_amount": 2,
        "offer_date_time": "sample string 3",
        "offer_user_declined": true,
        "company_address_city": "sample string 11",
        "company_address_district": "sample string 12",
        "company_address_neighborhood": "sample string 13",
        "company_address_street": "sample string 14",
        "company_address_zip_code": "sample string 15",
        "company_shipment_location_radius": 16,
        "licence_plate": "sample string 18"
      },
      {
        "offer_id": 1,
        "offer_amount": 2,
        "offer_date_time": "sample string 3",
        "offer_user_declined": true,
        "company_address_city": "sample string 11",
        "company_address_district": "sample string 12",
        "company_address_neighborhood": "sample string 13",
        "company_address_street": "sample string 14",
        "company_address_zip_code": "sample string 15",
        "company_shipment_location_radius": 16,
        "licence_plate": "sample string 18"
      }
    ],
    "offers_pending_departure_approval": [
      {
        "offer_id": 1,
        "offer_amount": 2,
        "offer_date_time": "sample string 3",
        "offer_user_declined": true,
        "company_address_city": "sample string 11",
        "company_address_district": "sample string 12",
        "company_address_neighborhood": "sample string 13",
        "company_address_street": "sample string 14",
        "company_address_zip_code": "sample string 15",
        "company_shipment_location_radius": 16,
        "licence_plate": "sample string 18"
      },
      {
        "offer_id": 1,
        "offer_amount": 2,
        "offer_date_time": "sample string 3",
        "offer_user_declined": true,
        "company_address_city": "sample string 11",
        "company_address_district": "sample string 12",
        "company_address_neighborhood": "sample string 13",
        "company_address_street": "sample string 14",
        "company_address_zip_code": "sample string 15",
        "company_shipment_location_radius": 16,
        "licence_plate": "sample string 18"
      }
    ],
    "offers_in_transit": [
      {
        "offer_id": 1,
        "offer_amount": 2,
        "offer_date_time": "sample string 3",
        "offer_user_declined": true,
        "company_address_city": "sample string 11",
        "company_address_district": "sample string 12",
        "company_address_neighborhood": "sample string 13",
        "company_address_street": "sample string 14",
        "company_address_zip_code": "sample string 15",
        "company_shipment_location_radius": 16,
        "licence_plate": "sample string 18"
      },
      {
        "offer_id": 1,
        "offer_amount": 2,
        "offer_date_time": "sample string 3",
        "offer_user_declined": true,
        "company_address_city": "sample string 11",
        "company_address_district": "sample string 12",
        "company_address_neighborhood": "sample string 13",
        "company_address_street": "sample string 14",
        "company_address_zip_code": "sample string 15",
        "company_shipment_location_radius": 16,
        "licence_plate": "sample string 18"
      }
    ],
    "offers_waiting_approval": [
      {
        "offer_id": 1,
        "offer_amount": 2,
        "offer_date_time": "sample string 3",
        "offer_user_declined": true,
        "company_address_city": "sample string 11",
        "company_address_district": "sample string 12",
        "company_address_neighborhood": "sample string 13",
        "company_address_street": "sample string 14",
        "company_address_zip_code": "sample string 15",
        "company_shipment_location_radius": 16,
        "licence_plate": "sample string 18"
      },
      {
        "offer_id": 1,
        "offer_amount": 2,
        "offer_date_time": "sample string 3",
        "offer_user_declined": true,
        "company_address_city": "sample string 11",
        "company_address_district": "sample string 12",
        "company_address_neighborhood": "sample string 13",
        "company_address_street": "sample string 14",
        "company_address_zip_code": "sample string 15",
        "company_shipment_location_radius": 16,
        "licence_plate": "sample string 18"
      }
    ],
    "offers_delivered": [
      {
        "offer_id": 1,
        "offer_amount": 2,
        "offer_date_time": "sample string 3",
        "offer_user_declined": true,
        "company_address_city": "sample string 11",
        "company_address_district": "sample string 12",
        "company_address_neighborhood": "sample string 13",
        "company_address_street": "sample string 14",
        "company_address_zip_code": "sample string 15",
        "company_shipment_location_radius": 16,
        "licence_plate": "sample string 18"
      },
      {
        "offer_id": 1,
        "offer_amount": 2,
        "offer_date_time": "sample string 3",
        "offer_user_declined": true,
        "company_address_city": "sample string 11",
        "company_address_district": "sample string 12",
        "company_address_neighborhood": "sample string 13",
        "company_address_street": "sample string 14",
        "company_address_zip_code": "sample string 15",
        "company_shipment_location_radius": 16,
        "licence_plate": "sample string 18"
      }
    ],
    "offers_problem_transit": [
      {
        "offer_id": 1,
        "offer_amount": 2,
        "offer_date_time": "sample string 3",
        "offer_user_declined": true,
        "company_address_city": "sample string 11",
        "company_address_district": "sample string 12",
        "company_address_neighborhood": "sample string 13",
        "company_address_street": "sample string 14",
        "company_address_zip_code": "sample string 15",
        "company_shipment_location_radius": 16,
        "licence_plate": "sample string 18"
      },
      {
        "offer_id": 1,
        "offer_amount": 2,
        "offer_date_time": "sample string 3",
        "offer_user_declined": true,
        "company_address_city": "sample string 11",
        "company_address_district": "sample string 12",
        "company_address_neighborhood": "sample string 13",
        "company_address_street": "sample string 14",
        "company_address_zip_code": "sample string 15",
        "company_shipment_location_radius": 16,
        "licence_plate": "sample string 18"
      }
    ],
    "offer_last_delivered_shipment": "sample string 1"
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}