7x Developer Portal & API Documentation

Checks whether shipment customer actions are available for the given AWB. Returns action availability and explanatory messaging for current shipment state.

Request builder

GET

/api/v1/Shipments/CheckShipmentOptions

Access Token

AWBstring

SelectedActionstring

RequestSourcestring

api-versionstring

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

AWB?string

SelectedAction?string

Value in

"None"
"PayForDelivery"
"BranchPickUp"
"PudoPickUp"
"PayOnly"

RequestSource?string

Value in

"Web"
"Mobile"

api-version?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/Shipments/CheckShipmentOptions"

{  "list": [    {      "awb": "string",      "isAvailable": true,      "message": "string"    }  ],  "count": 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

Checks whether shipment customer actions are available for the given AWB. Returns action availability and explanatory messaging for current shipment state.

Request builder

GET

/api/v1/Shipments/CheckShipmentOptions

Access Token

AWBstring

SelectedActionstring

RequestSourcestring

api-versionstring

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

AWB?string

SelectedAction?string

Value in

"None"
"PayForDelivery"
"BranchPickUp"
"PudoPickUp"
"PayOnly"

RequestSource?string

Value in

"Web"
"Mobile"

api-version?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/Shipments/CheckShipmentOptions"

{  "list": [    {      "awb": "string",      "isAvailable": true,      "message": "string"    }  ],  "count": 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}

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`