Customer Delivery Preferences API

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

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

mobileNumbers
array of strings | null
mobileNumbers
Responses

500

Internal Server Error

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json