7x Developer Portal & API Documentation

Executes a shipment-level action such as bookmark, alias, or dispute. Persists the selected action against the provided AWB and request source context.

Request builder

POST

/api/v1/Shipments/Actions

Access Token

api-versionstring

*object

requestSourcestring

awb*string

selectedActionstring

shipmentNamestring

actionTypestring

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/Actions" \  -H "Content-Type: application/json" \  -d '{    "awb": "string"  }'

{  "message": "string",  "payload": "string",  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

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

Executes a shipment-level action such as bookmark, alias, or dispute. Persists the selected action against the provided AWB and request source context.

Request builder

POST

/api/v1/Shipments/Actions

Access Token

api-versionstring

*object

requestSourcestring

awb*string

selectedActionstring

shipmentNamestring

actionTypestring

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

selectedAction?ShipmentActions

Value in

"Bookmark"
"UnBookMark"
"Alias"
"Dispute"

shipmentName?string

actionType?ActionType

Value in

"Shipment"
"Enquiry"

Response Body

`application/json`

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

{  "message": "string",  "payload": "string",  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

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

selectedAction?ShipmentActions

Value in

"Bookmark"
"UnBookMark"
"Alias"
"Dispute"

shipmentName?string

actionType?ActionType

Value in

"Shipment"
"Enquiry"

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`