7x Developer Portal & API Documentation

Loading developer portal

Preparing the API reference and documentation.

Overview

Saves complete PO Box rental request data including profiles, services, and payment setup. Creates order context for subsequent payment and confirmation steps.

Request builder

Reference details

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

requestSource?Source

Value in

"Web"
"Mobile"
"AutoRenewJobEngine"
"Wayn"
"Escher"

additionalServiceDetailList?array<>

keyDeliveryAddress?

listBoxAgentDetail?array<>

mainCorporateProfile?

myHomeProfile?

subscriptionReferenceNumber*string

Length1 <= length

orderNumber?string

totalAmount*number

Formatdouble

userProfile*

paymentProperties*

resellerId?string

isCorporateInfoAutoPopulated?boolean

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/Rental/Save" \  -H "Content-Type: application/json" \  -d '{    "subscriptionReferenceNumber": "string",    "totalAmount": 0.1,    "userProfile": {},    "paymentProperties": {}  }'

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

Request Body

Response Body

200application/json

400application/json

404application/json

500application/json

Query Parameters

Request Body

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`