7x Developer Portal & API Documentation

Updates the destination PO Box details for a shipment identified by AWB. Used when rerouting eligible shipments to a different PO Box number and city.

Request builder

POST

/api/v1/Shipments/UpdatePoBox

Access Token

api-versionstring

*object

requestSourcestring

awb*string

cityCode*string

poBoxNumber*string

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/Shipments/UpdatePoBox" \  -H "Content-Type: application/json" \  -d '{    "awb": "string",    "cityCode": "string",    "poBoxNumber": "string"  }'

{  "statusCode": 0}

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

Updates the destination PO Box details for a shipment identified by AWB. Used when rerouting eligible shipments to a different PO Box number and city.

Request builder

POST

/api/v1/Shipments/UpdatePoBox

Access Token

api-versionstring

*object

requestSourcestring

awb*string

cityCode*string

poBoxNumber*string

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

requestSource?Source

Value in

"Web"
"Mobile"

awb*string

Length1 <= length

cityCode*string

Length1 <= length

poBoxNumber*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/Shipments/UpdatePoBox" \  -H "Content-Type: application/json" \  -d '{    "awb": "string",    "cityCode": "string",    "poBoxNumber": "string"  }'

{  "statusCode": 0}

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

requestSource?Source

Value in

"Web"
"Mobile"

awb*string

Length1 <= length

cityCode*string

Length1 <= length

poBoxNumber*string

Length1 <= length

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`