Headquarter
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.
L'oggetto headquarter
Attributi
id integer
Identificatore univoco per l'oggetto.
name string
Nome della sede.
dealer object
Informazioni del dealer della sede.
address object
Indirizzo della sede.
email string
Email di contatto alla quale vengono inviate le lead.
website string
Sito web della sede.
reviews array
Recensioni rilasciate dai clienti.
telephone object
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.
{
"id": 1,
"name": "Headquarter",
"dealer": {
"id": 1,
"name": "AutoSuperMarket",
"logoFile": {
"publicUrl": "https://cdn.autosupermarket.it/uploads/dev/upload-6400b48ea2f6d6.96515650.png"
},
"logo": "https://cdn.autosupermarket.it/uploads/dev/upload-6400b48ea2f6d6.96515650.png"
},
"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]",
"website": "",
"reviews": [
{
"id": 1,
"name": "Mario Rossi",
"content": "Servizio impeccabile!",
"datetime": "2023-06-22T08:08:10.310Z",
"rating": 4,
"avatarFile": {
"publicUrl": "https://cdn.autosupermarket.it/uploads/prod/upload-3829182531.321321.png"
}
}
],
"telephone": [
"prefix": "+39",
"telephone": "0305543434"
],
"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 univoco della sede 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.
curl -X GET \
'https://api.autosupermarket.it/dealer/headquarters/:id' \
-H 'Content-Type: application/json' \
-H 'X-Auth-Token: {your-token-here}'{
"id": 1,
"name": "Headquarter",
"dealer": {
"id": 1,
"name": "AutoSuperMarket",
"logoFile": {
"publicUrl": "https://cdn.autosupermarket.it/uploads/dev/upload-6400b48ea2f6d6.96515650.png"
},
"logo": "https://cdn.autosupermarket.it/uploads/dev/upload-6400b48ea2f6d6.96515650.png"
},
"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]",
"website": "",
"reviews": [
{
"id": 1,
"name": "Mario Rossi",
"content": "Servizio impeccabile!",
"datetime": "2023-06-22T08:08:10.310Z",
"rating": 4,
"avatarFile": {
"publicUrl": "https://cdn.autosupermarket.it/uploads/prod/upload-3829182531.321321.png"
}
}
],
"telephone": [
"prefix": "+39",
"telephone": "0305543434"
],
"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 l'headquarter specificato impostando i valori dei parametri passati. Eventuali parametri non forniti verranno lasciati invariati.
Parametri
name string
Percorsi URL delle fotografie della sede.
email string
Email di contatto al quale vengono inviate le lead.
telephone object
Numero di telefono con prefisso al quale vengono inoltrate le chiamate degli utenti.
website string
Sito web della sede.
description string
Breve descrizione della sede.
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, altrimenti ritorna un errore.
curl -X PATCH \
'https://api.autosupermarket.it/dealer/headquarters/:id' \
-H 'Content-Type: application/merge-patch+json' \
-H 'X-Auth-Token: {your-token-here}
-d '{"name": "Nuovo nome della headquarter"}''{
"id": 1,
"name": "Nuovo nome della headquarter",
"dealer": {
"id": 1,
"name": "AutoSuperMarket",
"logoFile": {
"publicUrl": "https://cdn.autosupermarket.it/uploads/dev/upload-6400b48ea2f6d6.96515650.png"
},
"logo": "https://cdn.autosupermarket.it/uploads/dev/upload-6400b48ea2f6d6.96515650.png"
},
"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]",
"website": "",
"reviews": [
{
"id": 1,
"name": "Mario Rossi",
"content": "Servizio impeccabile!",
"datetime": "2023-06-22T08:08:10.310Z",
"rating": 4,
"avatarFile": {
"publicUrl": "https://cdn.autosupermarket.it/uploads/prod/upload-3829182531.321321.png"
}
}
],
"telephone": [
"prefix": "+39",
"telephone": "0305543434"
],
"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.
curl -X DELETE \
'https://api.autosupermarket.it/dealer/headquarters/:id' \
-H 'X-Auth-Token: {your-token-here}'