getEntities

POST

/rest/2.0/personWebService/getEntities

Maintainer:Martin DA COSTA NETO

Permet de récupérer les informations concernant les magasins.

Il retourne la liste des entités correspondantes aux critères de recherche.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Header Params

Body Params application/json

Example

{
   "entityIdentifiers": "?",
   "entityIds": "?",
   "GeoRequest": {
      "latitude": "?",
      "longitude": "?",
      "radius": "?"
   },
   "zipCodes": "?"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/rest/2.0/personWebService/getEntities' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
   "entityIdentifiers": "?",
   "entityIds": "?",
   "GeoRequest": {
      "latitude": "?",
      "longitude": "?",
      "radius": "?"
   },
   "zipCodes": "?"
}'

Responses

🟢200Success

application/json

Body

Example

{
    "responseCode": "000",
    "infos": "Request successfully processed",
    "EntityResponses": [
        {
            "name": "MAGASIN TEST",
            "id": "461",
            "identifier": "666666",
            "latitude": 48.866,
            "longitude": 2.333,
            "loyalty": 1,
            "internalCode": "CASHDESK",
            "AddressResponse": {
                "status": 1,
                "country": "FRANCE",
                "address3Type": 0,
                "city": "MARCQ EN BAROEUL",
                "zipCode": "59700",
                "allowCompanySolicitation": 1,
                "allowTrustedSolicitation": 0
            }
        }
    ]
}

Modified at 2025-09-30 09:34:45

updateForm

getEntityParents