7x Developer Portal & API Documentation

Returns agency-managed PO Boxes filtered by box id, city, and status criteria. Supports operational views for agency users and delegated PO Box management.

Request builder

GET

/api/v1/PoBoxes/GetAgencyBoxes

Access Token

boxIdstring

cityCodestring

boxStatusstring

api-versionstring

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

boxId?string

cityCode?string

boxStatus?string

api-version?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/PoBoxes/GetAgencyBoxes"

[  {    "bundleName": "string",    "uniqueBoxId": 0,    "boxNumber": 0,    "cityCode": "string",    "cityName": "string",    "custProfId": "string",    "expiryDate": "2019-08-24T14:15:22Z",    "assignedBranchName": "string",    "status": "Free",    "bundleId": "string",    "ownerName": "string",    "createdDate": "2019-08-24T14:15:22Z",    "boxRejectReason": "string",    "assignedBranchId": "string",    "agencyBoxStatus": "string"  }]

{  "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 agency-managed PO Boxes filtered by box id, city, and status criteria. Supports operational views for agency users and delegated PO Box management.

Request builder

GET

/api/v1/PoBoxes/GetAgencyBoxes

Access Token

boxIdstring

cityCodestring

boxStatusstring

api-versionstring

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

boxId?string

cityCode?string

boxStatus?string

api-version?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/PoBoxes/GetAgencyBoxes"

[  {    "bundleName": "string",    "uniqueBoxId": 0,    "boxNumber": 0,    "cityCode": "string",    "cityName": "string",    "custProfId": "string",    "expiryDate": "2019-08-24T14:15:22Z",    "assignedBranchName": "string",    "status": "Free",    "bundleId": "string",    "ownerName": "string",    "createdDate": "2019-08-24T14:15:22Z",    "boxRejectReason": "string",    "assignedBranchId": "string",    "agencyBoxStatus": "string"  }]

{  "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}

Authorization

Query Parameters

Response Body

200application/json

400application/json

404application/json

500application/json

Authorization

Query Parameters

Response Body

200application/json

400application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`