POST v1/admin/shipment/company-shipment-count

ADMIN - Company Shipment Count List

Request Information

URI Parameters

None.

Body Parameters

AdminListCompanyShipmentCountRequestModel

Name	Description	Type	Additional information
page_number		integer	Required
page_length		integer	Required
order	Filter order types : company_name,company_uid,1000,2000,3000,4000,5000,6000,7000,10000	string	None.
order_asc	Filter shipments order ASC : true \| DESC : false	boolean	None.
company_uids		Collection of string	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:

{
  "page_number": 1,
  "page_length": 2,
  "order": "sample string 3",
  "order_asc": true,
  "company_uids": [
    "sample string 1",
    "sample string 2"
  ],
  "user_company_id": "sample string 5",
  "user_id": "sample string 6",
  "user_signature": "sample string 7"
}

Response Information

Resource Description

ADMIN - Company Shipment Count List

BaseMetaResultModelOfAdminListCompanyShipmentCountResponseModel

Name	Description	Type	Additional information
response		AdminListCompanyShipmentCountResponseModel	None.
meta	Basic meta information for the operation result	MetaModel	None.

Response Format

application/json, text/json

Sample:

{
  "response": {
    "total_count": 1,
    "list": [
      {
        "company_uid": "sample string 1",
        "company_name": "sample string 2",
        "company_counts": [
          {
            "shipment_state": "sample string 1",
            "shipment_count": 2
          },
          {
            "shipment_state": "sample string 1",
            "shipment_count": 2
          }
        ]
      },
      {
        "company_uid": "sample string 1",
        "company_name": "sample string 2",
        "company_counts": [
          {
            "shipment_state": "sample string 1",
            "shipment_count": 2
          },
          {
            "shipment_state": "sample string 1",
            "shipment_count": 2
          }
        ]
      }
    ]
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}