Magazzini

In questa sezione viene illustrato come ottenere informazioni relative ai magazzini del Merchant presenti sulla piattaforma.

I magazzini sono i magazzini associati al Merchant presenti sulla piattaforma di GEL Proximity che possono essere utilizzati per gestire ordini di spedizione e di reso. È possibile gestire e abilitare i magazzini 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 estrarre la lista dei magazzini associati al Merchant.

Parametri

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

Request

Nome Tipo Obbl. Default Descrizione
manageShipping boolean Si – Indica se restituire i magazzini che gestiscono ordini di spedizione
manageReturn boolean Si – Indica se restituire i magazzini che gestiscono ordini di reso
zipCode string Si – CAP della città dei magazzini 
https://platform.gelproximity.com/gel-api-server/api/merchant/pickingPoint/search?
&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 Warehouse[] Dati restituiti

Warehouse

Nome Tipo Descrizione
code string Codice del magazzino
description string Descrizione del magazzino
address string Indirizzo del magazzino
city string Città del magazzino
zipCode string CAP del magazzino
department string Provincia del magazzino
country string Nazione del magazzino
phoneNumber string Numero di telefono del magazzino
email string Email del magazzino
coordLat number Latitudine del magazzino
coordLong number Longitudine del magazzino
currencyDefault string Valuta del magazzino in formato ISO4217
manageShipping boolean Indica se il magazzino può essere utilizzato per ordini di spedizione
manageReturn boolean Indica se il reso può essere utilizzato per ordini di spedizione
isDefault boolean Indica se il magazzino è il magazzino di default 
{
  "success": true,
  "message": "Operazione completata",
  "total": 1,
  "items": [
    {
      "code": "PIN_543881",
      "description": "Magazzino principale",
      "address": "Via Rossi 10",
      "city": "Milano",
      "zipcode": "20019",
      "department": "Milano",
      "country": "IT",
      "phoneNumber": "3331535985",
      "email": "magazzino@email.com",
      "coordLat": 10.05637,
      "coordLong": -16.35622,
      "currencyDefault": "EUR",
      "manageShipping": true,
      "manageReturn": true,
      "isDefault": false,
    },
    ...
  ],
}

Permette di creare un Magazzino associato al Merchant.

Parametri

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

Request

Nome Tipo Obbl. Default Descrizione
name string Si – Nome del magazzino
address string Si – Indirizzo del magazzino
city string Si – Città del magazzino
zipCode string Si – CAP del magazzino
department string Si – Provincia del magazzino
country string Si – Paese del magazzino
email string Si – Email del magazzino
phone string No – Telefono del magazzino
lat number No – Latitudine del magazzino
lon number No – Longitudine del magazzino
currency string Si – Valuta del magazzino
brtDepartureDepot string No – Codice BRT di spedizione del magazzino
brtReturnDepot string No – Codice BRT di reso del magazzino
amOpeningTimeFrom string Si – Orario di apertura mattutina del magazzino
amOpeningTimeTo string Si – Orario di chiusura mattutina del magazzino
pmOpeningTimeFrom string Si – Orario di apertura pomeridiana del magazzino
pmOpeningTimeTo string Si – Orario di chiusura pomeridiana del magazzino
shippingEnabled boolean Si – Indica se il magazzino è abilitato per ordini di spedizione
shippingDefault boolean Si – Indica se il magazzino deve essere considerato come default per ordini di spedizione
returnEnabled boolean Si – Indica se il magazzino è abilitato per ordini di reso
returnDefault boolean Si – Indica se il magazzino deve essere considerato come default per ordini di reso
bookingEnabled boolean Si – Indica se per ogni ordine confermato deve essere prenotato un ritiro
bookingCutoffTime string Si – Orario in cui viene inviata la richiesta il ritiro al corriere
pickingTime string Si – Orario a cui viene richiesto il ritiro della merce al corriere
sameDayPickupEnabled boolean Si – Indica se al corriere deve essere richiesto il ritiro nello stesso giorno in cui viene inviata la richiesta di ritiro 
{
  "name": "Warehouse - Merchant API 2",
  "address": "Via nazionale 3",
  "city": "Demonte",
  "zipCode": "12014",
  "department": "CN",
  "country": "IT",
  "email": "a@magazzino.it",
  "amOpeningTimeFrom": "08:00",
  "amOpeningTimeTo": "11:23",
  "pmOpeningTimeFrom": "15:00",
  "pmOpeningTimeTo": "18:23",
  "shippingEnabled": true,
  "returnEnabled": true ,
  "shippingDefault": false,
  "returnDefault": false,
  "bookingEnabled": true ,
  "bookingCutOffTime": "20:23",
  "pickingTime": "10:27",
  "bookingTodayEnabled": true
}

Response

Nome Tipo Descrizione
success boolean Esito della richiesta
message string Messaggio di risposta
data MerchantData Dati restituiti

WarehouseData

Nome Tipo Descrizione
code string Codice GEL del magazzino
... any Tutti i dati inseriti in fase di creazione del magazzino 
{
  "success": true,
  "message": "Magazzino inserito",
  "data": {
    "code": "PIN_543881",
    ...
  }
}

Permette di aggiornare un Magazzino associato al Merchant.

Parametri

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

Request

Nome Tipo Obbl. Default Descrizione
code string Si – Codice del magazzino
name string Si – Nome del magazzino
address string Si – Indirizzo del magazzino
city string Si – Città del magazzino
zipCode string Si – CAP del magazzino
department string Si – Provincia del magazzino
country string Si – Paese del magazzino
email string Si – Email del magazzino
phone string No – Telefono del magazzino
lat number No – Latitudine del magazzino
lon number No – Longitudine del magazzino
currency string Si – Valuta del magazzino
brtDepartureDepot string No – Codice BRT di spedizione del magazzino
brtReturnDepot string No – Codice BRT di reso del magazzino
amOpeningTimeFrom string Si – Orario di apertura mattutina del magazzino
amOpeningTimeTo string Si – Orario di chiusura mattutina del magazzino
pmOpeningTimeFrom string Si – Orario di apertura pomeridiana del magazzino
pmOpeningTimeTo string Si – Orario di chiusura pomeridiana del magazzino
shippingEnabled boolean Si – Indica se il magazzino è abilitato per ordini di spedizione
shippingDefault boolean Si – Indica se il magazzino deve essere considerato come default per ordini di spedizione
returnEnabled boolean Si – Indica se il magazzino è abilitato per ordini di reso
returnDefault boolean Si – Indica se il magazzino deve essere considerato come default per ordini di reso
bookingEnabled boolean Si – Indica se per ogni ordine confermato deve essere prenotato un ritiro
bookingCutoffTime string Si – Orario in cui viene inviata la richiesta il ritiro al corriere
pickingTime string Si – Orario a cui viene richiesto il ritiro della merce al corriere
sameDayPickupEnabled boolean Si – Indica se al corriere deve essere richiesto il ritiro nello stesso giorno in cui viene inviata la richiesta di ritiro 
{
  "code": "PIN_543881"
  "name": "Warehouse - Merchant API 2",
  "address": "Via nazionale 3",
  "city": "Demonte",
  "zipCode": "12014",
  "department": "CN",
  "country": "IT",
  "email": "a@magazzino.it",
  "amOpeningTimeFrom": "08:00",
  "amOpeningTimeTo": "11:23",
  "pmOpeningTimeFrom": "15:00",
  "pmOpeningTimeTo": "18:23",
  "shippingEnabled": true,
  "returnEnabled": true ,
  "shippingDefault": false,
  "returnDefault": false,
  "bookingEnabled": true ,
  "bookingCutOffTime": "20:23",
  "pickingTime": "10:27",
  "bookingTodayEnabled": true
}

Response

Nome Tipo Descrizione
success boolean Esito della richiesta
message string Messaggio di risposta
data MerchantData Dati restituiti

WarehouseData

Nome Tipo Descrizione
... any Tutti i dati inseriti in fase di creazione del magazzino 
{
  "success": true,
  "message": "Magazzino inserito",
  "data": {
    ...
  }
}

Permette di aggiornare i parametri di booking di un Magazzino associato al Merchant.

Parametri

Endpoint gel-api-server/api/merchant/pickingPoint/updateBooking
Metodo POST

Request

Nome Tipo Obbl. Default Descrizione
pickingPointCode string Si – Codice del Magazzino
networkCode string No – Codice della Rete
bookingEnabled boolean Si – Indica se il booking deve essere abilitato
sameDayPickupEnabled boolean No – Indica se abilitare il pickup in giornata
bookingCutoffTime string No – Orario di prenotazione del ritiro in formato HH:mm
pickingTime string Si – Orario di ritiro comunicato al corriere in formato HH:mm 
{
  "pickingPointCode": "PIN_543881"
  "bookingEnabled": true,
  "sameDayPickupEnabled": true,
  "pickingTime": "15:00"
}

Response

Nome Tipo Descrizione
success boolean Esito della richiesta
message string Messaggio di risposta 
{
  "success": true,
  "message": "Booking aggiornato"
}

Permette di richiedere manualmente il ritiro ad un Magazzino associato al Merchant.

Il ritiro verrà richiesto per tutte le spedizioni per cui è già stata generata un’etichetta.

Parametri

Endpoint gel-api-server/api/merchant/pickingPoint/booking
Metodo POST

Request

Nome Tipo Obbl. Default Descrizione
pickingPointCode string Si – Codice del Magazzino
networkCode string No – Codice della Rete 
{
  "pickingPointCode": "PIN_543881"
}

Response

Nome Tipo Descrizione
success boolean Esito della richiesta
message string Messaggio di risposta 
{
  "success": true,
  "message": "Operazione effettuata"
}