POST v1/company/shipment/offer-report

Request Information

URI Parameters

None.

Body Parameters

CompanyShipmentOfferReportsRequestModel
NameDescriptionTypeAdditional information
shipment_company_id

string

Required

shipment_id

integer

None.

shipment_state

integer

None.

shipment_state_list

Collection of integer

None.

shipment_custom_id

string

None.

departure_address_id

integer

None.

create_date_begin

date

None.

create_date_end

date

None.

departure_date_begin

date

None.

departure_date_end

date

None.

arrival_address_id

integer

None.

arrival_date_begin

date

None.

arrival_date_end

date

None.

amount_begin

decimal number

None.

amount_end

decimal number

None.

distance_begin

integer

None.

distance_end

integer

None.

driver_user_id

string

None.

vehicle_licence_plate

string

None.

destination_count

integer

None.

page_number

integer

None.

page_length

integer

None.

order

string

None.

order_asc

boolean

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_company_id": "sample string 1",
  "shipment_id": 2,
  "shipment_state": 3,
  "shipment_state_list": [
    1,
    2
  ],
  "shipment_custom_id": "sample string 4",
  "departure_address_id": 1,
  "create_date_begin": "2024-05-09T20:57:57.9987938+03:00",
  "create_date_end": "2024-05-09T20:57:57.9987938+03:00",
  "departure_date_begin": "2024-05-09T20:57:57.9987938+03:00",
  "departure_date_end": "2024-05-09T20:57:57.9987938+03:00",
  "arrival_address_id": 1,
  "arrival_date_begin": "2024-05-09T20:57:57.9987938+03:00",
  "arrival_date_end": "2024-05-09T20:57:57.9987938+03:00",
  "amount_begin": 1.1,
  "amount_end": 1.1,
  "distance_begin": 1,
  "distance_end": 1,
  "driver_user_id": "sample string 5",
  "vehicle_licence_plate": "sample string 6",
  "destination_count": 1,
  "page_number": 7,
  "page_length": 8,
  "order": "sample string 9",
  "order_asc": true,
  "user_company_id": "sample string 11",
  "user_id": "sample string 12",
  "user_signature": "sample string 13"
}

Response Information

Resource Description

BaseMetaResultModel
NameDescriptionTypeAdditional information
meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}