7x Developer Portal & API Documentation

Overview

Retrieves all delivery addresses and customer delivery preferences for the specified mobile numbers. This endpoint requires Bearer (JWT) authentication obtained from /auth/authenticate.

Behavior:

Normalizes input mobile numbers to digits-only form (removes leading +, 00 or local 0).
Returns a dictionary mapping each mobile number to an array of Address objects.
Each address includes coordinates, building and apartment details, address label and delivery preferences.

Limits & validation:

Maximum 100 mobile numbers per request.
mobileNumbers cannot be null or empty.
Mobile number format validated by the API validator; validation failures return VALIDATION_ERROR.

Common error codes: INVALID_PAYLOAD, EMPTY_MOBILE_NUMBERS, MAX_ITEMS_EXCEEDED, VALIDATION_ERROR, ADDRESSES_NOT_FOUND, DB_REACH_ERROR.

Request builder

Reference details

Authorization

Bearer

AuthorizationBearer <token>

Please enter into field the word 'Bearer' followed by a space and the JWT value.

In: header

Request Body

application/json

The reach request containing a list of mobile numbers to retrieve addresses for.

TypeScript Definitions

Use the request body type in TypeScript.

{ "status": "Success", "message": "Reach request processed successfully. Retrieved addresses for 1 mobile numbers.", "data": { "971529694603": [ { "id": 10, "area": "Qusais 1", "emirate": "Dubai", "latitude": 25.2727302, "longitude": 55.3733848, "type": "0", "buildingName": "talal", "apartmentNo": "101", "floor": "1", "street": "-24-doha", "additionalDirections": "left", "mobileNumberPrefix": "+971", "mobileNumber": "971552845787", "addressLabel": "Home", "house": "talal", "company": "", "isTemporary": false, "isDefault": false, "preferences": [ { "days": [ "Sunday", "Monday", "Saturday" ], "deliveryIntentions": [ "Personal", "Bank" ], "fromTime": "09:00:00", "toTime": "17:00:00", "noContactDelivery": true, "keepAtDoorStep": false, "dontRingBell": false } ] }, { "id": 12, "area": "Garhoud", "emirate": "Dubai", "latitude": 25.2373421, "longitude": 55.3583388, "type": "0", "buildingName": "abc", "apartmentNo": "230", "floor": "2", "street": "56 Street-7-", "additionalDirections": "", "mobileNumberPrefix": "+971", "mobileNumber": "971552845787", "addressLabel": "Annys home", "house": "abc", "company": "", "isTemporary": false, "isDefault": false, "preferences": [] } ] }}

{ "status": "string", "message": "string", "data": null, "errors": [ { "code": "string", "message": "string", "field": "string" } ], "correlationId": "string", "timestamp": "2019-08-24T14:15:22Z"}

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

500

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

500

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`