Store

Contain all the operations related to stores.


Parameters

Name In Type Required Description
limit query string false Maximum number of stores to be returned.
postalCode query string true Postal code to obtain the N nearest stores.
storeDelivery query boolean false Indicates that the shop must have a store delivery service.
deviceReturn query boolean false Indicates that the shop must have a device return service.
subchannels query string false List of subchannels to which the shops to be consulted should belong.
brands query string false List of brands sold by the shops to be returned.

Request example

1
2
3
4

curl -X GET https://dealers.masstack.com/v1/stores?limit='10'&postalCode='string'&storeDelivery='false'&deviceReturn='false'&subchannels='MI,OU'&brands='yoigo,masmovil'?postalCode=string \
  -H "Accept: application/json"

Responses

Code Meaning Description Schema
200 OK Successful response. Stores has been found. [Store]
400 Bad Request Bad request ApiErrorResponse
401 Unauthorized Unauthorized string
500 Internal Server Error Internal Server Error ApiErrorResponse

200 - instance of Store

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
[
  {
    "dealerCode": "string",
    "commercialName": "string",
    "addressInfo": {
      "address": "C/Ocaña 9",
      "city": "Madrid",
      "province": "Madrid",
      "postalCode": 28011,
      "country": "ES"
    },
    "phoneNumber": "string",
    "email": "string",
    "location": {
      "latitude": 40.4124967,
      "longitude": -3.8706208
    },
    "distance": 330.15,
    "storeDelivery": false,
    "deviceReturn": false,
    "brands": [
      {
        "code": "MM",
        "description": "masmovil"
      }
    ],
    "customInformation": [
      {
        "fieldId": 0,
        "dealerId": 0,
        "fieldValue": "string"
      }
    ]
  }
]
Name Type Required Description
dealerCode string false none
commercialName string false none
addressInfo Address false none
phoneNumber string false none
email string false none
location Location false none
distance number(double) false none
storeDelivery boolean false none
deviceReturn boolean false none
brands [Brand] false none
customInformation [DealerCustomInfoRequest] false [Dealer custom-info.]

400 - instance of ApiErrorResponse

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "errors": [
    {
      "code": "BAD_REQUEST",
      "title": "Error message",
      "ref": "some_ref",
      "details": "Detailed error message"
    }
  ]
}
Name Type Required Description
restErrors [ApiError] false none

401 - JsonObject

Custom schema example

1
2
3
4
5
6
{
  "code": "0003",
  "status": "UNAUTHORIZED",
  "message": "Unauthorized",
  "detailMsg": "Audience not found to access URI /example-uri"
}
Name Type Required Description
restErrors [ApiError] false none

500 - instance of ApiErrorResponse

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "title": "Error message",
      "ref": "some_ref",
      "details": "Detailed error message"
    }
  ]
}
Name Type Required Description
restErrors [ApiError] false none

Endpoints

Default

    Dealer

      Fiscal data

        Custom information

          Campaign

            Subchannel

              Store

                Iam

                  Request