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/GetShipments

Overview

Returns a paginated shipment list filtered by AWB, direction, status, dates, and source. Accepts PO Box criteria to scope results to customer-relevant consignments.

Request builder

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

AwbNo?string

Direction?string

Value in

"Inbound"
"Outbound"

Status?string

Value in

"All"
"DeliveredOnly"
"ActiveOnly"

FromDate?string

Formatdate-time

ToDate?string

Formatdate-time

Skip?integer

Formatint32

Take?integer

Formatint32

RequestSource?string

Value in

"Web"
"Mobile"

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

[index: integer]?

Response Body

`application/json`

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

{  "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",      "totalCharge": 0.1,      "status": {        "id": "string",        "text": "string",        "textAr": "string",        "code": "string",        "productType": "string"      },      "paymentStatus": "Paid",      "actionTaken": "None",      "shipmentName": "string",      "hasDipute": true,      "isDelivered": true,      "bundleId": "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

Returns a paginated shipment list filtered by AWB, direction, status, dates, and source. Accepts PO Box criteria to scope results to customer-relevant consignments.

Request builder

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

AwbNo?string

Direction?string

Value in

"Inbound"
"Outbound"

Status?string

Value in

"All"
"DeliveredOnly"
"ActiveOnly"

FromDate?string

Formatdate-time

ToDate?string

Formatdate-time

Skip?integer

Formatint32

Take?integer

Formatint32

RequestSource?string

Value in

"Web"
"Mobile"

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

[index: integer]?

Response Body

`application/json`

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

{  "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",      "totalCharge": 0.1,      "status": {        "id": "string",        "text": "string",        "textAr": "string",        "code": "string",        "productType": "string"      },      "paymentStatus": "Paid",      "actionTaken": "None",      "shipmentName": "string",      "hasDipute": true,      "isDelivered": true,      "bundleId": "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}

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`