7x Developer Portal & API Documentation

Returns available unassigned PO Boxes filtered by bundle, location, and reseller context. Can also consider hold references when continuing partially completed rentals.

Request builder

GET

/api/v1/Rental/FreeBoxes

BundleIdstring

LocationIdstring

HoldReferenceNumberstring

resellerIdstring

api-versionstring

Reference details

Query Parameters

BundleId?string

LocationId?string

HoldReferenceNumber?string

resellerId?string

api-version?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/Rental/FreeBoxes"

{  "message": "string",  "payload": [    {      "bundle_Id": "string",      "name_En": "string",      "name_Ar": "string",      "bundle_Price": "string",      "bundle24Month_Price": "string",      "bundle36Month_Price": "string",      "bundle60Month_Price": "string",      "bundle120Month_Price": "string",      "desc_En": "string",      "desc_Ar": "string",      "short_Desc_En": "string",      "short_Desc_Ar": "string",      "features_En": "string",      "features_Ar": "string"    }  ],  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

{  "message": "string",  "payload": null,  "responseCode": "Continue",  "errorDetails": {    "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 available unassigned PO Boxes filtered by bundle, location, and reseller context. Can also consider hold references when continuing partially completed rentals.

Request builder

GET

/api/v1/Rental/FreeBoxes

BundleIdstring

LocationIdstring

HoldReferenceNumberstring

resellerIdstring

api-versionstring

Reference details

Query Parameters

BundleId?string

LocationId?string

HoldReferenceNumber?string

resellerId?string

api-version?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/Rental/FreeBoxes"

{  "message": "string",  "payload": [    {      "bundle_Id": "string",      "name_En": "string",      "name_Ar": "string",      "bundle_Price": "string",      "bundle24Month_Price": "string",      "bundle36Month_Price": "string",      "bundle60Month_Price": "string",      "bundle120Month_Price": "string",      "desc_En": "string",      "desc_Ar": "string",      "short_Desc_En": "string",      "short_Desc_Ar": "string",      "features_En": "string",      "features_Ar": "string"    }  ],  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

{  "message": "string",  "payload": null,  "responseCode": "Continue",  "errorDetails": {    "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}

Query Parameters

Response Body

200application/json

400application/json

404application/json

500application/json

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`