7x Developer Portal & API Documentation

Loading developer portal

Preparing the API reference and documentation.

EP.Retail.PoBox.User.BackEnd.API EndPoints/Shipments//api/v1/Shipments/Charges

Overview

Calculates shipment-related charges and VAT for the selected customer action. Can include address-based recalculations when an updated delivery address is provided.

Request builder

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

{  "list": [    {      "awb": "string",      "sender": {        "contact": {          "name": "string",          "mobileNumber": "string",          "phoneNumber": "string",          "emailAddress": "string",          "companyName": "string",          "altMobileNumber": "string",          "altMobileNumber2": "string"        },        "address": {          "line1": "string",          "line2": "string",          "regionCode": "string",          "regionName": "string",          "city": "string",          "cityCode": "string",          "state": "string",          "countryCode": "string",          "zipCode": "string",          "point": {            "latitude": "string",            "longitude": "string"          },          "category": "Residential",          "streetName": "string",          "landmark": "string",          "buildingName": "string",          "floorNo": "string",          "apartmentNo": "string",          "officeId": "string",          "countryName": "string",          "route": "string",          "facility": "string",          "poBox": "string"        },        "referenceNo1": "string",        "referenceNo2": "string"      },      "receiver": {        "contact": {          "name": "string",          "mobileNumber": "string",          "phoneNumber": "string",          "emailAddress": "string",          "companyName": "string",          "altMobileNumber": "string",          "altMobileNumber2": "string"        },        "address": {          "line1": "string",          "line2": "string",          "regionCode": "string",          "regionName": "string",          "city": "string",          "cityCode": "string",          "state": "string",          "countryCode": "string",          "zipCode": "string",          "point": {            "latitude": "string",            "longitude": "string"          },          "category": "Residential",          "streetName": "string",          "landmark": "string",          "buildingName": "string",          "floorNo": "string",          "apartmentNo": "string",          "officeId": "string",          "countryName": "string",          "route": "string",          "facility": "string",          "poBox": "string"        },        "referenceNo1": "string",        "referenceNo2": "string"      },      "service": "string",      "totalAmount": 0.1,      "totalVAT": 0.1,      "charges": [        {          "amount": {            "amount": 0.1,            "adjustedDeclaredValueAmount": 0.1,            "currency": "string"          },          "vat": {            "amount": 0.1,            "adjustedDeclaredValueAmount": 0.1,            "currency": "string"          },          "code": "string",          "description": "string",          "postingInfo": {            "postingCrieteria": "Postal",            "mainSeriveId": "string",            "subServiceId": "string",            "vatServiceId": "string",            "serviceType": "string"          },          "groupName": "string",          "displayName": "string"        }      ],      "actionTaken": "None",      "isCustomsChargesApplied": true,      "status": {        "id": "string",        "text": "string",        "textAr": "string",        "code": "string",        "productType": "string"      },      "timeLine": [        {          "stepNo": 0,          "label": "string"        }      ],      "isAddressUpdateAllowed": true    }  ],  "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

Calculates shipment-related charges and VAT for the selected customer action. Can include address-based recalculations when an updated delivery address is provided.

Request builder

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*CustomerAction

Value in

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

updatedAddress?

Response Body

`application/json`

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

{  "list": [    {      "awb": "string",      "sender": {        "contact": {          "name": "string",          "mobileNumber": "string",          "phoneNumber": "string",          "emailAddress": "string",          "companyName": "string",          "altMobileNumber": "string",          "altMobileNumber2": "string"        },        "address": {          "line1": "string",          "line2": "string",          "regionCode": "string",          "regionName": "string",          "city": "string",          "cityCode": "string",          "state": "string",          "countryCode": "string",          "zipCode": "string",          "point": {            "latitude": "string",            "longitude": "string"          },          "category": "Residential",          "streetName": "string",          "landmark": "string",          "buildingName": "string",          "floorNo": "string",          "apartmentNo": "string",          "officeId": "string",          "countryName": "string",          "route": "string",          "facility": "string",          "poBox": "string"        },        "referenceNo1": "string",        "referenceNo2": "string"      },      "receiver": {        "contact": {          "name": "string",          "mobileNumber": "string",          "phoneNumber": "string",          "emailAddress": "string",          "companyName": "string",          "altMobileNumber": "string",          "altMobileNumber2": "string"        },        "address": {          "line1": "string",          "line2": "string",          "regionCode": "string",          "regionName": "string",          "city": "string",          "cityCode": "string",          "state": "string",          "countryCode": "string",          "zipCode": "string",          "point": {            "latitude": "string",            "longitude": "string"          },          "category": "Residential",          "streetName": "string",          "landmark": "string",          "buildingName": "string",          "floorNo": "string",          "apartmentNo": "string",          "officeId": "string",          "countryName": "string",          "route": "string",          "facility": "string",          "poBox": "string"        },        "referenceNo1": "string",        "referenceNo2": "string"      },      "service": "string",      "totalAmount": 0.1,      "totalVAT": 0.1,      "charges": [        {          "amount": {            "amount": 0.1,            "adjustedDeclaredValueAmount": 0.1,            "currency": "string"          },          "vat": {            "amount": 0.1,            "adjustedDeclaredValueAmount": 0.1,            "currency": "string"          },          "code": "string",          "description": "string",          "postingInfo": {            "postingCrieteria": "Postal",            "mainSeriveId": "string",            "subServiceId": "string",            "vatServiceId": "string",            "serviceType": "string"          },          "groupName": "string",          "displayName": "string"        }      ],      "actionTaken": "None",      "isCustomsChargesApplied": true,      "status": {        "id": "string",        "text": "string",        "textAr": "string",        "code": "string",        "productType": "string"      },      "timeLine": [        {          "stepNo": 0,          "label": "string"        }      ],      "isAddressUpdateAllowed": true    }  ],  "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}

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`