7x Developer Portal & API Documentation

Returns aggregate shipment count based on direction, status, date filters, and PO Boxes. Useful for dashboard badges and summary widgets in shipment management screens.

Request builder

POST

/api/v1/Shipments/GetShipmentCount

Access Token

Directionstring

Statusstring

FromDatestring

ToDatestring

api-versionstring

*array<object>

object

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

Direction?string

Value in

"Inbound"
"Outbound"

Status?string

Value in

"All"
"DeliveredOnly"
"ActiveOnly"

FromDate?string

Formatdate-time

ToDate?string

Formatdate-time

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

[index: integer]?

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/Shipments/GetShipmentCount" \  -H "Content-Type: application/json" \  -d '[    {}  ]'

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

Overview

Returns aggregate shipment count based on direction, status, date filters, and PO Boxes. Useful for dashboard badges and summary widgets in shipment management screens.

Request builder

POST

/api/v1/Shipments/GetShipmentCount

Access Token

Directionstring

Statusstring

FromDatestring

ToDatestring

api-versionstring

*array<object>

object

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

Direction?string

Value in

"Inbound"
"Outbound"

Status?string

Value in

"All"
"DeliveredOnly"
"ActiveOnly"

FromDate?string

Formatdate-time

ToDate?string

Formatdate-time

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

[index: integer]?

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/Shipments/GetShipmentCount" \  -H "Content-Type: application/json" \  -d '[    {}  ]'

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

200application/json

400application/json

404application/json

500application/json

200application/json

400application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`