Listing

L'oggetto headquarter rappresenta la sede fisica del concessionario. Ogni Dealer può avere una o più sedi fisiche, ognuna delle quali, essendo geolocalizzata diversamente sulla mappa, fornisce risultati di ricerca diversa all'utente.

Il feed dei veicoli è legato alla sede, ogni Dealer può decidere di creare una sola sede su AutoSuperMarket pur avendo più sedi fisiche, ma questo comporterà uno svantaggio durante la ricerca poichè tutti i veicoli verranno localizzati in quella sede e potrebbero non uscire nei risultati di un utente che effettua una ricerca per località. AutoSuperMarket consiglia sempre la creazione di una sede per ogni sede fisica del dealer.

La sede contiene tutte le informazioni del concessionario, compresi indirizzo, indirizzo di fatturazione, preferenze di contatto e orari di apertura.

Anche le lead generate all'interno di AutoSuperMarket sono legate alla sede alla quale l'autovettura appartiene e potranno essere gestite solo ed esclusivamente da utenti con permessi di gestione della sede stessa.

Endpoints

POST

/listing

GET

/listing/:id

PATCH

/listing/:id

DELETE

/listing/:id

L'oggetto headquarter

Attributi

id integer

Identificatore univoco per l'oggetto.

name string

Nome della sede.

dealer integer

ID del dealer della sede.

address object

Indirizzo della sede.

email string

Email di contatto al quale vengono inviate le lead.

telephone array

Numero di telefono con prefisso al quale vengono inoltrate le chiamate degli utenti.

photos array

Percorsi URL delle fotografie della sede.

whatsapp array

Numero di telefono di whatsapp al quale mandano i messaggi gli utenti.

activeSubscription object

Tipologia di account

L'oggetto Headquarter 
{
    "id": 1,
    "name": "Sede di AutoSuperMarket",
    "dealer": 1,
    "address": {
      "coordinates": {
        "latitude": 45.54656,
        "longitude": 10.16905
      },
      "city": "Brescia",
      "zipCode": "25132",
      "province": "BS",
      "address": "Via Valcamonica 19/H",
      "region": "Lombardia",
      "country": "IT"
    },
    "email": "[email protected]",
    "telephone": [],
    "photos": [
      {
        "id": 1,
        "photoFile": {
          "publicUrl": "https://cdn.autosupermarket.it/uploads/prod/upload-3829183921.321321.png"
        },
        "position": 0
      },
      {
        "id": 2,
        "photoFile": {
          "publicUrl": "https://cdn.autosupermarket.it/uploads/prod/upload-897863823.89549754.png"
        },
        "position": 1
      },
    ],
    "whatsapp": "0305543434",
    "activeSubscription": {
      "type": "pro"
    }
}

Crea un headquarter

Crea una nuova sede.

Parametri

dealer_id required integer

ID del dealer per il quale si intende aggiungere la nuova sede.

name required string

Percorsi URL delle fotografie della sede.

address object

Indirizzo della sede.

email string

Email di contatto al quale vengono inviate le lead.

telephone array

Numero di telefono con prefisso al quale vengono inoltrate le chiamate degli utenti.

whatsapp array

Numero di telefono di whatsapp al quale mandano i messaggi gli utenti.

Risposta

Ritorna l'oggetto headquarter se l'operazione è andata a buon fine.

POST /headquarter 
curl -X POST \
'https://api.autosupermarket.it/headquarter' \
-H 'Content-Type: application/json' \
-H 'X-Auth-Token: {your-token-here}'
Risposta 
{
    "id": 1,
    "name": "Sede di AutoSuperMarket",
    "dealer": 1,
    "address": {
      "coordinates": {
        "latitude": 45.54656,
        "longitude": 10.16905
      },
      "city": "Brescia",
      "zipCode": "25132",
      "province": "BS",
      "address": "Via Valcamonica 19/H",
      "region": "Lombardia",
      "country": "IT"
    },
    "email": "[email protected]",
    "telephone": [],
    "photos": [
      {
        "id": 1,
        "photoFile": {
          "publicUrl": "https://cdn.autosupermarket.it/uploads/prod/upload-3829183921.321321.png"
        },
        "position": 0
      },
      {
        "id": 2,
        "photoFile": {
          "publicUrl": "https://cdn.autosupermarket.it/uploads/prod/upload-897863823.89549754.png"
        },
        "position": 1
      },
    ],
    "whatsapp": "0305543434",
    "activeSubscription": {
      "type": "pro"
    }
}

Ottieni l'headquarter

Recupera i dettagli di una sede esistente. Fornisci l'ID della sede univoco e AutoSuperMarket restituirà le informazioni corrispondenti.

Parametri

Nessun paramentro.

Risposta

Restituisce un oggetto headquarter se è stato fornito un identificatore valido e restituisce un errore in caso contrario.

GET /listing/:id 
curl -X GET \
'https://api.autosupermarket.it/headquarter/:id' \
-H 'Content-Type: application/json' \
-H 'X-Auth-Token: {your-token-here}'
Risposta 
{
    "id": 1,
    "name": "Sede di AutoSuperMarket",
    "dealer": 1,
    "address": {
      "coordinates": {
        "latitude": 45.54656,
        "longitude": 10.16905
      },
      "city": "Brescia",
      "zipCode": "25132",
      "province": "BS",
      "address": "Via Valcamonica 19/H",
      "region": "Lombardia",
      "country": "IT"
    },
    "email": "[email protected]",
    "telephone": [],
    "photos": [
      {
        "id": 1,
        "photoFile": {
          "publicUrl": "https://cdn.autosupermarket.it/uploads/prod/upload-3829183921.321321.png"
        },
        "position": 0
      },
      {
        "id": 2,
        "photoFile": {
          "publicUrl": "https://cdn.autosupermarket.it/uploads/prod/upload-897863823.89549754.png"
        },
        "position": 1
      },
    ],
    "whatsapp": "0305543434",
    "activeSubscription": {
      "type": "pro"
    }
}

Aggiorna l'headquarter

Aggiorna il headquarter specificato impostando i valori dei parametri passati. Eventuali parametri non forniti verranno lasciati invariati.

Parametri

name string

Percorsi URL delle fotografie della sede.

address object

Indirizzo della sede.

email string

Email di contatto al quale vengono inviate le lead.

telephone array

Numero di telefono con prefisso al quale vengono inoltrate le chiamate degli utenti.

whatsapp array

Numero di telefono di whatsapp al quale mandano i messaggi gli utenti.

Risposta

Restituisce un oggetto headquarter aggiornato se l'aggiornamento è andato a buon fine.

PATCH /listing/:id 
curl -X PATCH \
'https://api.autosupermarket.it/headquarter/:id' \
-H 'Content-Type: application/json' \
-H 'X-Auth-Token: {your-token-here}'
Risposta 
{
    "id": 1,
    "name": "Sede di AutoSuperMarket",
    "dealer": 1,
    "address": {
      "coordinates": {
        "latitude": 45.54656,
        "longitude": 10.16905
      },
      "city": "Brescia",
      "zipCode": "25132",
      "province": "BS",
      "address": "Via Valcamonica 19/H",
      "region": "Lombardia",
      "country": "IT"
    },
    "email": "[email protected]",
    "telephone": [],
    "photos": [
      {
        "id": 1,
        "photoFile": {
          "publicUrl": "https://cdn.autosupermarket.it/uploads/prod/upload-3829183921.321321.png"
        },
        "position": 0
      },
      {
        "id": 2,
        "photoFile": {
          "publicUrl": "https://cdn.autosupermarket.it/uploads/prod/upload-897863823.89549754.png"
        },
        "position": 1
      },
    ],
    "whatsapp": "0305543434",
    "activeSubscription": {
      "type": "pro"
    }
}

Elimina l'headquarter

Elimina un headquarter. L'eliminazione di un headquarter è possibile solo se non ci sono annunci associati attualmente pubblicati.

Parametri

Nessun paramentro.

Risposta

Restituisce codice HTTP 200 se l'aggiornamento è andato a buon fine, altrimenti ritorna un errore.

DELETE /listing/:id 
curl -X DELETE \
'https://api.autosupermarket.it/headquarter/:id' \
-H 'Content-Type: application/json' \
-H 'X-Auth-Token: {your-token-here}'