POST v1/company/shipment/count

WEB - LIST SHIPMENT COUNTS.

Request Information

URI Parameters

None.

Body Parameters

ShipmentCountRequestModel
NameDescriptionTypeAdditional information
company_id

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

Response Information

Resource Description

WEB - LIST SHIPMENT COUNTS.

ShipmentCountResultModel
NameDescriptionTypeAdditional information
response

ShipmentCountResponseModel

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": {
    "count_pending_offer": 1,
    "count_pending_driver_approval": 2,
    "count_pending_payment": 3,
    "count_pending_driver_departure_approval": 4,
    "count_in_transit": 5,
    "count_pending_driver_arrival_approval": 6,
    "count_pending_company_arrival_approval": 7,
    "count_completed": 8
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}