Resi

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

La richiesta di creazione di un ordine di Reso è asincrona: prima dell’avvenuta importazione 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": "19209",
  "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 reso associato al Merchant.

Un ordine di reso può essere annullato solo nel caso non sia già stato preso in carico dalla Rete designata. Una volta che un ordine di reso è stato preso in carico dalla Rete 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 reso, utile per effettuare successive operazioni sull’ordine tramite API.

Parametri

Request

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

Response

OrderIdentifier

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

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

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/return/getIdentifier?
&orderReferenceCode=4a48926aarv76430e776e3w11pomuua2

Response

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

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

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 reso.

Parametri

Request

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

Response

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