Reti

In questa sezione viene illustrato come ottenere informazioni relative alle Reti presenti sulla piattaforma.

Le Reti in GEL Proximity sono insiemi di Punti di Ritiro appartenenti a corrieri o a terze parti che offrono i propri Punti di Ritiro a cui è possibile spedire e rendere pacchi. È 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 delle Reti associate al Merchant.

Parametri

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

Request

Nome Tipo Obbl. Default Descrizione
manageShipping boolean Si – Indica se restituire le Reti che gestiscono ordini di spedizione
manageReturn boolean Si – Indica se restituire le Reti che gestiscono ordini di reso 
https://platform.gelproximity.com/gel-api-server/api/merchant/network/search?
&manageShipping=true
&manageReturn=true

Response

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

Network

Nome Tipo Descrizione
code NetworkCode Codice della Rete
description string Descrizione della Rete
address string Indirizzo della Rete
city string Città della Rete
zipcode string CAP della Rete
country string Nazione della Rete
manageShipping boolean Indica se la Rete può essere utilizzata per ordini di spedizione
manageReturn boolean Indica se la Rete può essere utilizzata per ordini di reso
managePrenegotiated boolean Indica se la Rete può essere utilizzata in modalità prenegoziata
manageLabeling boolean Indica se la Rete può essere utilizzata in modalità labeling
shippingEnabled boolean Indica se la Rete è abilitata in modalità spedizione
returnEnabled boolean Indica se la Rete è abilitata in modalità reso
shippingServiceType NetworkType Indica il tipo di servizio con cui la Rete è abilitata in modalità spedizione
returnServiceType NetworkType Indica il tipo di servizio con cui la Rete è abilitata in modalità reso 
{
  "success": true,
  "message": "Operazione completata",
  "total": 1,
  "items": [
    {
      "code": "NET_000042",
      "description": "TNT Point",
      "address": "via Rossi 10",
      "city": "Milano",
      "zipcode": "20019",
      "country": "IT",
      "manageShipping": true,
      "manageReturn": true,
    }
  ],
}

Permette di aggiornare la configurazione di una Rete associata al Merchant.

Parametri

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

Request

Nome Tipo Obbl. Default Descrizione
code string Si – Codice della Rete
enabled boolean Si – Indica se la Rete deve essere abilitata
shippingEnabled boolean Si – Indica se la Rete deve essere abilitata per ordini di spedizione
returnEnabled boolean Si – Indica se la Rete deve essere abilitata per ordini di reso
shipmentServiceType NetworkType Si – Indica in quale modalità deve essere abilitata la Rete per ordini di spedizione
returnServiceType NetworkType Si – Indica in quale modalità deve essere abilitata la Rete per ordini di reso
labelingContract NetworkContractData No – Dati del contratto
warehouse NetworkWarehouse[] No – Dati dei magazzini

NetworkContractData

Nome Tipo Obbl. Default Descrizione
user string Si – Codice utente del contratto
password string Si – Password utente del contratto
serviceType NetworkServiceType No – Servizio da abilitare
customerCode string Si – Codice Customer del contratto
customerType string Si – Tipologia Customer del contratto
productCode string Si – Codice Prodotto del contratto
contractCode string Si – Codice del contratto
locationCode string Si – Codice Location del contratto
subAccount string Si – Sottoaccount del contratto
shipmentTarifCode string Si – Codice Tariffa per spedizioni del contratto
returnTarifCode string Si – Codice Tariffa per resi del contratto
cc string Si – Codice CC del contratto
sftpHost string Si – Host SFTP del contratto
sftpUser string Si – Utente SFTP del contratto
sftpPassword string Si – Password SFTP del contratto
billing NetworkBillingData No – Dati di fatturazione del contratto

NetworkBillingData

Nome Tipo Obbl. Default Descrizione
type string Si – Tipologia dell’account di fatturazione
accountNumber string Si – Numero dell’account di fatturazione
zipCode string Si – CAP di fatturazione
countryCode string Si – Paese di fatturazione
pec string Si – PEC di fatturazione
sdi string Si – SDI di fatturazione

NetworkWarehouse

Nome Tipo Obbl. Default Descrizione
code string Si – Codice GEL del magazzino
brtDepartureDepot string Si – Codice BRT di spedizione del magazzino
brtReturnDepot string Si – Codice BRT di reso del magazzino 
{
  "code": "NET_000003",
  "enabled": true,
  "shippingEnabled": true,
  "returnEnabled": true,
  "shipmentServiceType": "prenegotiated",
  "returnServiceType": "prenegotiated"
}

Response

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

{
  "success": true,
  "message": "Sottoscrizione aggiornata"
}