Spedizioni

Gli ordini di spedizione su GEL Proximity sono spedizioni che hanno come punto di partenza un magazzino del Merchant e come punto di destinazione un Punto di Ritiro appartenente ad una Rete o al Merchant stesso. È possibile gestire e monitorare gli ordini di spedizione associati al 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 creare un nuovo ordine di spedizione associato al Merchant autenticato sulla piattaforma GEL Proximity.

La richiesta di creazione di un ordine di spedizione è asincrona: prima dell’avvenuta importazione dell’ordine non sarà possibile effettuare azioni sull’ordine creato. Per maggiori informazioni sul funzionamento visitare la sezione Caratteristiche di Sistema.

Parametri

Request

OrderItem

{
  "customer": "Mario Rossi",
  "customerEmail": "mario.rossi@email.com",
  "customerPhone": "3331535985",
  "orderNumber": "19664",
  "orderNumberRif": "19664",
  "reference": "orderReference-19664",
  "orderDate": "20221201",
  "description": "Descrizione dell'ordine",
  "codePickupPoint": "PUP_325389",
  "proximityPrice": 4.99,
  "orderCountInCurrentYear": 5344,
  "rows": [
    {
      "description": "Giacca di pelle nera",
    },
    ...
  ]
}

Response

OrderIdentifier

{
  "success": true,
  "message": "Operazione completata",
  "data": {
    "orderReferenceCode": "4a48926aarv76430e776e3w11pomuua2",
    "pickupPointPublicCode": "965512"
  }
}

Permette di annullare un ordine di spedizione associato al Merchant.

Un ordine di spedizione può essere annullato solo nel caso non sia già stata generata l’etichetta. Una volta che per un ordine di spedizione verrà generata l’etichetta non sarà più possibile annullarlo.

Parametri

Request

{
  "orderReferenceCode": "4a48926aarv76430e776e3w11pomuua2", "notes": "" }

Response

{
  "success": true,
  "message": "Ordine annullato",
}

Permette il ottenere il codice di riferimento di un ordine di spedizione, utile per effettuare successive operazioni sull’ordine tramite API.

Parametri

Request

https://platform.gelproximity.com/gel-api-server/api/merchant/shipment/getIdentifier?
&orderNumber=19664

Response

OrderIdentifier

{
  "success": true,
  "message": "Operazione completata",
  "data": {
      "orderReferenceCode": "4a48926aarv76430e776e3w11pomuua2",
    }
  }
}

Permette il generare l’etichetta associata ad un ordine di spedizione nel caso di merchant di tipo DELIVERY o di confermare l’ordine per la spedizione nel caso di merchant di tipo STORAGE.

In caso di merchant di tipo DELIVERY l’etichetta verrà restituita nella response in formato base64.

In caso di merchant di tipo STORAGE non verrà restituita nessuna etichetta ma verrà confermata la spedizione e comunicata al Punto di Ritiro per permettergli di gestire il ritiro e la consegna.

Le performance di generazione dell’etichetta dipendono direttamente dallo stato dei sistemi delle Reti relative.

Parametri

Request

{
  "orderReferenceCode": "4a48926aarv76430e776e3w11pomuua2",
}

Response

LabelInfo

LabelCustomer

LabelOrder

LabelPickupPoint

LabelNetwork

LabelWarehouse

LabelData

</tr

LabelMetadata

{
  "success": true,
  "message": "Operazione completata",
  "data": {
    "customer": {
      "name": "Mario Rossi",
      "email": "mario.rossi@email.com",
      "phone": "3331535985",
    },
    "order": {
      "orderReferenceCode": "4a48926aarv76430e776e3w11pomuua2",
      "orderNumber": "19664",
      "orderDate": "01/01/2022",
      "serviceCode": "001",
    },
    "pickupPoint": {
      "code": "PUP_325389",
      "name": "TNT Point",
      "address": "Via Rossi 10",
      "city": "Milano",
      "zipcode": "20019",
      "department": "Milano",
      "country": "IT",
    },
    "network": {
      "code": "NET_000042",
      "name": "TNT Point",
    },
    "warehouse": {
      "code": "PIN_543881",
      "description": "Magazzino principale",
      "address": "Via Rossi 10",
      "city": "Milano",
      "zipcode": "20019",
      "department": "Milano",
      "country": "IT",
    },
    "label": {
      "trackingNumber": "056010930020137843",
      "format": "PDF",
      "data": "...",
    },
    "metadata": {
      "parcelId": "155321943321451115"
    }
  }
}

Permette il ottenere l’etichetta associata ad un ordine di spedizione.

Questo metodo funziona solo se l’etichetta è già stata precedentemente generata dalla piattaforma GEL Proximity. Per maggiori informazioni sul funzionamento visitare la sezione Caratteristiche di Sistema.

In caso la chiamata vada a buon fine verrà restituito il PDF dell’etichetta sotto forma di File.

Parametri

Request

https://platform.gelproximity.com/gel-api-server/api/merchant/shipment/downloadLabel?
&orderReferenceCode=4a48926aarv76430e776e3w11pomuua2

Response

{
  "success": true,
  "message": "Operazione completata"
}

Permette il ricevere lo stato di uno o più ordini di spedizione.

Parametri

Request

OrderIdentifier

Almeno uno tra i parametri orderReferenceCode e orderNumber deve essere valorizzato nella request.

{
  "request": [
    {
      "orderReferenceCode": "4a48926aarv76430e776e3w11pomuua2"
    },
    ...
  ]
}

Response

OrderInfo

OrderDetails

OrderTracking

OrderMetadata

{
  "success": true,
  "message": "Operazione completata",
  "total": 1,
  "items": [
    {
      "success": true,
      "message": "Ordine estratto"
      "order": {
        "orderReferenceCode": "4a48926aarv76430e776e3w11pomuua2",
        "orderNumber": "19664",
        "orderDate": "20221201",
        "reference": "orderReference-19664",
      },
      "tracking": {
        "number": "056010930020137843",
        "status": "ST0006",
        "statusDescription": "Errore: verificare tracking",
        "externalStatusCode": "RECIPIENT_MISSING",
        "externalStatusDescription": "Il destinatario era assente",
        "lastUpdateDate": "01/01/2022",
        "lastUpdateTime": "15:30",
        "deliveryDate": null,
        "deliveryTime": null,
      },
      "metadata": {
        "parcelId": "155321943321451115"
      }
    },
    ...
  ]
}

Permette di aggiornare lo stato del tracking di un ordine di spedizione.

In caso di spedizione diretta ad un Punto di Ritiro che richiede un codice di verifica per effettuare la consegna all’utente finale, se si intende aggiornare lo stato con statusCode ST_0007, il parametro verificationCode risulterà obbligatorio.

Parametri

Request

{
  "orderReferenceCode": "4a48926aarv76430e776e3w11pomuua2",
  "statusCode": "ST_0001",
  "statusDescription": "Descrizione del cambio di stato"
}

Response

{
  "success": true,
  "message": "Tracking aggiornato",
}

Permette di inviare il codice di verifica richiesto dai Punti di Ritiro per consegnare il pacco all’utente finale.

Il codice di verifica verrà inviato via email all’indirizzo email associato alla spedizione

Parametri

Request

{
  "orderReferenceCode": "4a48926aarv76430e776e3w11pomuua2"
}

Response

{
  "success": true,
  "message": "Codice inviato correttamente",
}