POST v1/company/shipment/statistics

Request Information

URI Parameters

None.

Body Parameters

ShipmentStatisticReportRequestModel
NameDescriptionTypeAdditional information
shipment_company_id

string

Required

report_day

integer

None.

report_type

integer

None.

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

Response Information

Resource Description

BaseMetaResultModelOfShipmentStatisticReportResponseModel
NameDescriptionTypeAdditional information
response

ShipmentStatisticReportResponseModel

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": {
    "shipmentStateStatistics": [
      {
        "shipment_company_id": "sample string 1",
        "shipment_company_name": "sample string 2",
        "shipment_state": 3,
        "shipment_state_count": 4,
        "is_subcompany": true,
        "shipment_date": "2024-05-09T17:36:58.5296795+03:00"
      },
      {
        "shipment_company_id": "sample string 1",
        "shipment_company_name": "sample string 2",
        "shipment_state": 3,
        "shipment_state_count": 4,
        "is_subcompany": true,
        "shipment_date": "2024-05-09T17:36:58.5296795+03:00"
      }
    ],
    "shipmentApprovalStateStatistics": [
      {
        "shipment_company_id": "sample string 1",
        "shipment_company_name": "sample string 2",
        "shipment_declined_count": 3,
        "shipment_accepted_count": 4,
        "shipment_date": "2024-05-09T17:36:58.5296795+03:00",
        "is_subcompany": true
      },
      {
        "shipment_company_id": "sample string 1",
        "shipment_company_name": "sample string 2",
        "shipment_declined_count": 3,
        "shipment_accepted_count": 4,
        "shipment_date": "2024-05-09T17:36:58.5296795+03:00",
        "is_subcompany": true
      }
    ]
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}