7x Developer Portal & API Documentation

Loading developer portal

Preparing the API reference and documentation.

Overview

Calculates guest renewal charges based on box details, expiry, bundle changes, and options. Provides a pricing breakdown that should be reviewed before creating payment orders.

Request builder

Reference details

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

boxNumber*string

Length1 <= length

emirateCode*string

Length1 <= length

expiryDate?string

Formatdate-time

isBundleChanged?boolean

newBundleId?string

physicalBoxRequired?boolean

discountRequest?

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/Guest/Renewal/Pricing" \  -H "Content-Type: application/json" \  -d '{    "boxNumber": "string",    "emirateCode": "string"  }'

{  "isSuccess": true,  "responseMessage": "string",  "responseCode": 0,  "errorDetail": {    "httpStatusCode": "string",    "poBoxErrorCode": "string",    "displayMessage": "string"  },  "poBoxPrice": {    "amount": 0.1,    "totalDiscountAmount": 0.1,    "poBoxPriceDetailsList": [      {        "amount": 0.1,        "service": "string",        "serviceId": "string",        "serviceDesc": "string",        "year": 0,        "fromDate": "2019-08-24T14:15:22Z",        "toDate": "2019-08-24T14:15:22Z",        "bundleId": "string",        "bundleName": "string",        "qty": 0,        "serviceCriteriaDesc": "string",        "serviceCriteria": "Mandatory",        "discount": {          "discountId": "string",          "description": "string",          "discountType": "Flat",          "discountValue": 0.1,          "discountMapId": "string",          "actualPrice": 0.1,          "discount": 0.1,          "priceAfterDiscount": 0.1,          "discountServiceId": "string",          "bundleId": "string",          "serviceName": "string",          "serviceId": "string",          "serviceType": "string"        }      }    ]  }}

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

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`