Punti di Ritiro

In questa sezione viene illustrato come ottenere informazioni relative ai Punti di Ritiro presenti sulla piattaforma.

I Punti di Ritiro sono punti fisici a cui è possibile spedire e rendere pacchi: GEL Proximity fornisce decine di migliaia di Punti di Ritiro appartenenti alle principali Reti. È possibile gestire e abilitare le Reti e conseguentemente i Punti di Ritiro utilizzabili dal Merchant in qualsiasi momento accedendo al pannello di amministrazione.

Per utilizzare le API presenti in questa guida è necessario essere autenticati alla piattaforma. Per maggiori informazioni consultare la sezione Autenticazione.

Permette di ottenere la lista dei Punti di Ritiro associati al Merchant. È possibile effettuare la ricerca in due modalità:

  1. Per posizione: restituisce i Punti di Ritiro all’interno di un’area con centro in un punto definito dai parametri latLocation e lonLocation con raggio definito dal parametro maxDistance.
  2. Per CAP: restituisce i Punti di Ritiro per CAP definito dal parametro zipCode.

Una tipologia di ricerca esclude l’altra.

Parametri

Endpoint gel-api-server/api/merchant/pickupPoint/search
Metodo GET

Request

Nome Tipo Obbl. Default Descrizione
readNetworkPickupPoints boolean Si – Indica se restituire i Punti di Ritiro appartenenti a una Rete
readMerchantPickupPoints boolean Si – Indica se restituire i Punti di Ritiro appartenenti al Merchant
manageShipping boolean Si – Indica se restituire i Punti di Ritiro che gestiscono ordini di spedizione
manageReturn boolean Si – Indica se restituire i Punti di Ritiro che gestiscono ordini di reso
zipCode string Si – CAP della città dei Punti di Ritiro
countryCode string No – Nazione della città dei Punti di Ritiro
latLocation number Si – Latitudine del centro in cui estrarre i Punti di Ritiro
lonLocation number Si – Longitudine del centro in cui estrarre i Punti di Ritiro
maxDistance number Si 50 Raggio in Km dai parametri latLocation e lonLocation entro la quale estrarre i Punti di Ritiro.
parcelWidth number No – Larghezza del pacco in cm
parcelHeight number No – Altezza del pacco in cm
parcelDepth number No – Profondità del pacco in cm
parcelVolume number No – Volume del pacco in cm
parcelGrossWeight number No – Peso del pacco in cm 
https://platform.gelproximity.com/gel-api-server/api/merchant/pickupPoint/search?
&readMerchantPickupPoints=false
&readNetworkPickupPoints=true
&manageShipping=true
&manageReturn=true
&zipCode=20125

Response

Nome Tipo Descrizione
success boolean Esito della request
message string Messaggio di risposta
total number Numero di record restituiti
items PickupPoint[] Dati restituiti

PickupPoint

Nome Tipo Descrizione
code string Codice del Punto di Ritiro
name string Nome del Punto di Ritiro
address string Indirizzo del Punto di Ritiro
city string Città del Punto di Ritiro
zipcode string CAP del Punto di Ritiro
department string Provincia del Punto di Ritiro
country string Nazione del Punto di Ritiro
urlLogo string Url del logo del Punto di Ritiro
urlLogoNetworkMerchant string Url del logo del Punto di Ritiro impostato del Merchant
lat number Latitudine del Punto di Ritiro
lon number Longitudine del Punto di Ritiro
rating number Rating del Punto di Ritiro
price number Prezzo di spedizione del Punto di Ritiro impostato dal Merchant
currency string Valuta del prezzo in formato ISO4217
manageShipping boolean Indica se il Punto di Ritiro accetta ordini di spedizione
manageReturn boolean Indica se il Punto di Ritiro accetta ordini di reso
networkCode NetworkCode Codice della Rete
networkName string Nome della Rete
serviceType NetworkType Tipologia del servizio associato alla Rete a cui appartiene il Punto di Ritiro
calendar PickupPointDay[] Giorni di apertura del Punto di Ritiro

PickupPointDay

Nome Tipo Descrizione
day CalendarDay Giorno della settimana
dayDescription string Nome del giorno della settimana
amOpeningTimeFrom string Orario di apertura al mattino
amOpeningTimeTo string Orario di chiusura al mattino
pmOpeningTimeFrom string Orario di apertura al pomeriggio
pmOpeningTimeTo string Orario di chiusura al pomeriggio 
{
  "success": true,
  "message": "Operazione completata",
  "total": 1,
  "items": [
    {
      "code": "PUP_325389",
      "name": "TNT Point",
      "email": "mario.rossi@email.com",
      "phoneNumber": "3331535985",
      "address": "Via Rossi 10",
      "city": "Milano",
      "zipcode": "20019",
      "department": "Milano",
      "country": "IT",
      "urlLogo": "https://test-platform.gelproximity.com/aX76tYum34pmuqw96Gtr.svg",
      "urlLogoNetworkMerchant": "https://test-platform.gelproximity.com/wL50mUii09pjhjq55Rde.svg", 
      "lat": 10.05637,
      "lon": -16.35622,
      "rating": 4.5,
      "price": 4.99,
      "currency": "EUR",
      "manageShipping": true,
      "manageReturn": true,
      "networkCode": "NET_000042",
      "networkName": "TNT Point",
      "serviceType": "PRENEGOTIATED",
      "calendar": [
        {
          "day": 1,
          "dayDescription": "Lunedì",
          "amOpeningTimeFrom": "08:00",
          "amOpeningTimeTo": "12:30",
          "pmOpeningTimeFrom": "14:30",
          "pmOpeningTimeTo": "18:30"
        },
        ...
      ],  
    }
  ],
}

Permette di ottenere lo stato di un Punto di Ritiro.

Parametri

Endpoint gel-api-server/api/merchant/pickupPoint/status
Metodo POST

Request

Nome Tipo Obbl. Default Descrizione
pickupPointCode string Si – Codice del Punto di Ritiro
codePickingPoint string No – Codice del Magazzino
grossWeight number No – Peso del pacco
width number No – Lunghezza del pacco
height number No – Altezza del pacco
depth number No – Spessore del pacco 
{
  "codePickupPoint": "PUP_325389",
}

Response

Nome Tipo Descrizione
success boolean Esito della request
message string Messaggio di risposta
data PickupPointStatusData Dati restituiti

PickupPointStatusData

Nome Tipo Descrizione
network NetworkData Dati relativi alla Rete
pickupPoint PickupPointData Dati relativi al Punto di Ritiro
estimatedCosts EstimatedCostsData Indirizzo del Punto di Ritiro

NetworkData

Nome Tipo Descrizione
code NetworkCode Codice della Rete
name string Nome della Rete

PickupPoint

Nome Tipo Descrizione
code string Codice del Punto di Ritiro
name string Nome del Punto di Ritiro
email string Email del Punto di Ritiro
phone string Numero di telefono del Punto di Ritiro
address string Indirizzo del Punto di Ritiro
city string Città del Punto di Ritiro
zipcode string CAP del Punto di Ritiro
department string Provincia del Punto di Ritiro
country string Nazione del Punto di Ritiro
urlLogo string Url del logo del Punto di Ritiro
urlLogoNetworkMerchant string Url del logo del Punto di Ritiro impostato del Merchant
lat number Latitudine del Punto di Ritiro
lon number Longitudine del Punto di Ritiro
rating number Rating del Punto di Ritiro
manageShipping boolean Indica se il Punto di Ritiro accetta ordini di spedizione
manageReturn boolean Indica se il Punto di Ritiro accetta ordini di reso
calendar PickupPointDay[] Giorni di apertura del Punto di Ritiro

PickupPointDay

Nome Tipo Descrizione
day CalendarDay Giorno della settimana
dayDescription string Nome del giorno della settimana
amOpeningTimeFrom string Orario di apertura al mattino
amOpeningTimeTo string Orario di chiusura al mattino
pmOpeningTimeFrom string Orario di apertura al pomeriggio
pmOpeningTimeTo string Orario di chiusura al pomeriggio

EstimatedCostsData

Nome Tipo Descrizione
costPickupPoint number Prezzo per la spedizione al Punto di Ritiro
costZone number Prezzo relativo ai surcharge di zona della spedizione al Punto di Ritiro
cost number Prezzo totale per la spedizione al Punto di Ritiro
costCurrencyCode string Valuta del prezzo in formato ISO4217 
{
  "success": true,
  "message": "Operazione completata",
  "data": {
    "network": {
      "code": "NET_000042",
      "name": "TNT Point"
    },
    "pickupPoint": {
      "code": "PUP_325389",
      "name": "TNT Point",
      "email": "mario.rossi@email.com",
      "phone": "3331535985",
      "address": "Via Rossi 10",
      "city": "Milano",
      "zipcode": "20019",
      "department": "Milano",
      "country": "IT",
      "urlLogo": "https://test-platform.gelproximity.com/aX76tYum34pmuqw96Gtr.svg",
      "urlLogoNetworkMerchant": "https://test-platform.gelproximity.com/wL50mUii09pjhjq55Rde.svg", 
      "lat": 10.05637,
      "lon": -16.35622,
      "rating": 4.5,
      "currency": "EUR",
      "manageShipping": true,
      "manageReturn": true,
      "calendar": [
        {
          "day": 1,
          "dayDescription": "Lunedì",
          "amOpeningTimeFrom": "08:00",
          "amOpeningTimeTo": "12:30",
          "pmOpeningTimeFrom": "14:30",
          "pmOpeningTimeTo": "18:30"
        },
        ...
      ],  
    },
    "estimatedCosts": {
      "costPickupPoint": 5.00,
      "costZone": 0.00,
      "cost": 5.00,
      "costCurrencyCode": "EUR"
    }
  }
}

Permette di creare un Punto di Ritiro “proprietario” associato al Merchant. Il Punto di Ritiro creato, se abilitato, sarà visualizzabile assieme agli altri Punti di Ritiro abilitati e potrà essere utilizzato per ricevere pacchi.

Parametri

Endpoint gel-api-server/api/merchant/pickupPoint/create
Metodo POST

Request

Nome Tipo Obbl. Default Descrizione
name string Si – Nome del Punto di Ritiro
enabled boolean Si – Indica se il Punto di Ritiro è abilitato
publicCode string Si – Codice del Punto di Ritiro
email string Si – Email del Punto di Ritiro
phone string Si – Numero di telefono del Punto di Ritiro
address string Si – Indirizzo del Punto di Ritiro
city string Si – Città del Punto di Ritiro
zipCode string Si – CAP della città dei Punti di Ritiro
department string Si – Provincia del Punti di Ritiro
country string Si – Paese del Punto di Ritiro
lat number Si – Latitudine del Punto di Ritiro
lon number Si – Longitudine del Punto di Ritiro
openingTimes PickupPointDay[] Si – Giorni di apertura del Punto di Ritiro
booking BookingData No – Configurazioni per il ritiro, necessario se il Punto di Ritiro viene utilizzato per ricevere resi

PickupPointDay

Nome Tipo Obbl. Default Descrizione
day CalendarDay Si – Giorno della settimana
amOpeningTimeFrom string Si – Orario di apertura al mattino in formato HH:mm
amOpeningTimeTo string Si – Orario di chiusura al mattino in formato HH:mm
pmOpeningTimeFrom string Si – Orario di apertura al pomeriggio in formato HH:mm
pmOpeningTimeTo string Si – Orario di chiusura al pomeriggio in formato HH:mm

BookingData

Nome Tipo Obbl. Default Descrizione
enabled boolean Si – Indica se il booking per la prenotazione di un ritiro è abilitato
sameDay boolean Si – Indica se le prenotazioni devono essere fatte per lo stesso giorno. Funziona solo se i parametri cutOffTime e pickingTime sono configurati in fasce orarie supportate dal corriere
cutOffTime string Si – Orario del giorno in cui viene comunicato il ritiro al corriere in formato HH:mm
pickingTime string Si – Orario del giorno in cui si chiede al corriere di passare per effettuare il ritiro in formato HH:mm 
{
  "name": "Punto di Ritiro Proprietario",
  "enabled": true,
  "publicCode": "145773",
  "email": "mario.rossi@email.com",
  "phone": "3331535985",
  "address": "Via Rossi 10",
  "city": "Milano",
  "zipCode": "20019",
  "department": "Milano",
  "country": "IT",
  "lon":10.05637,
  "lat":-16.35622,
  "openingTimes": [
    {
      "day": "1",
      "amOpeningTimeFrom": "08:00",
      "amOpeningTimeTo": "12:30",
      "pmOpeningTimeFrom": "14:30",
      "pmOpeningTimeTo": "18:30"
    }
  ],
  "booking": {
    "enabled" : true,
    "sameDay" : false,
    "cutOffTime" : "20:00",
    "pickingTime" : "13:00"
  }
}

Response

Nome Tipo Descrizione
success boolean Esito della request
message string Messaggio di risposta
data PickupPointData Dati restituiti

PickupPointData

Nome Tipo Descrizione
code string Codice identificativo del Punto di Ritiro
... any Tutti i dati inseriti in fase di creazione del Punto di Ritiro 
{
  "success": true,
  "message": "Operazione completata",
  "data": {
    "code": "PUP_325389",
    ...
  }
}

Permette di aggiornare i dati di un Punto di Ritiro “proprietario” associato al Merchant.

Parametri

Endpoint gel-api-server/api/merchant/pickupPoint/update
Metodo POST

Request

Nome Tipo Obbl. Default Descrizione
code string Si – Codice identificativo del Punto di Ritiro
name string Si – Nome del Punto di Ritiro
enabled boolean Si – Indica se il Punto di Ritiro è abilitato
publicCode string Si – Codice del Punto di Ritiro
email string Si – Email del Punto di Ritiro
phone string Si – Numero di telefono del Punto di Ritiro
address string Si – Indirizzo del Punto di Ritiro
city string Si – Città del Punto di Ritiro
zipCode string Si – CAP della città dei Punti di Ritiro
department string Si – Provincia del Punti di Ritiro
country string Si – Paese del Punto di Ritiro
lat number Si – Latitudine del Punto di Ritiro
lon number Si – Longitudine del Punto di Ritiro
openingTimes PickupPointDay[] Si – Giorni di apertura del Punto di Ritiro
booking BookingData No – Configurazioni per il ritiro, necessario se il Punto di Ritiro viene utilizzato per ricevere resi

PickupPointDay

Nome Tipo Obbl. Default Descrizione
day CalendarDay Si – Giorno della settimana
dayDescription string Si – Nome del giorno della settimana
amOpeningTimeFrom string Si – Orario di apertura al mattino in formato HH:mm
amOpeningTimeTo string Si – Orario di chiusura al mattino in formato HH:mm
pmOpeningTimeFrom string Si – Orario di apertura al pomeriggio in formato HH:mm
pmOpeningTimeTo string Si – Orario di chiusura al pomeriggio in formato HH:mm

BookingData

Nome Tipo Obbl. Default Descrizione
enabled boolean Si – Indica se il booking per la prenotazione di un ritiro è abilitato
sameDay boolean Si – Indica se le prenotazioni devono essere fatte per lo stesso giorno. Funziona solo se i parametri cutOffTime e pickingTime sono configurati in fasce orarie supportate dal corriere
cutOffTime string Si – Orario del giorno in cui viene comunicato il ritiro al corriere in formato HH:mm
pickingTime string Si – Orario del giorno in cui si chiede al corriere di passare per effettuare il ritiro in formato HH:mm 
{
  "code": "PUP_325389",
  "name": "Punto di Ritiro Proprietario",
  "enabled": true,
  ...
}

Response

Nome Tipo Descrizione
success boolean Esito della request
message string Messaggio di risposta