Creazione Rimborsi

La creazione dei rimborsi è gestita da Flowlyze attraverso un Webhook di Flowlyze.

Configurazione del Flusso di Creazione Rimborsi

Oltre alla configurazione base del flusso dati, è necessario aggiungere le seguenti impostazioni nei Settings Override della destinazione:

Campo	Valore	Note
Base Url	https://adapt.flowlyze.com	url degli adapter
Resource Path	api/adp/shopify/egress/create-refund-on-shopify	path dell'adapter per il flusso di creazione dei rimborsi.
Headers :: x-api-key	**********	L'api key di verifica per l'interazione con l'endpoint
Headers :: x-shopify-access-token	shpat_CODICEALFANUMERICO	Secret della custom app creata per l'integrazione
Headers :: x-shopify-graphql-url	https://SHOPIFYURL.myshopify.com/	Url dello shopify con cui connettersi

Messaggio di Input

Il messaggio da inviare per creare il rimborso è caratterizzato dai seguenti campi:

• orderName : nome dell'ordine da rimborsare (obbligatorio).
• refundAmount : valore del rimborso in testata, si applica su tutte le righe ordine.
• refundShippingAmount : valore del rimborso sulla spedizione.
• refundAllItems : campo per abilitare rimborso totale sulle righe ordine.
• totalShippingRefund : campo per abilitare rimborso totale sulla spedizione.
• refundLineItems : collezione delle righe ordine da rimborsare e relative specifiche.
• notifyCustomer : campo per indicare se notificare il cliente o meno (default: true).
• reason : campo per indicare la motivazione del rimborso.

Ogni oggetto del campo refundLineItems è caratterizzato dai seguenti campi:

• sku : sku della riga ordine da rimborsare (obbligatorio).
• quantity : quantità degli oggetti rimborsati di una riga ordine.
• refundAmount : valore del rimborso sulla riga ordine.
• refundLineTotally : campo per abilitare il rimborso totale di una singola riga ordine.

Alcune proprietà sono tra loro mutuamente esclusive, e non possono essere impostate simultaneamente:

• refundShippingAmount e totalShippingRefund non possono essere entrambe valorizzate; se è impostato il rimborso totale della spedizione, l’importo specifico del rimborso deve essere pari a zero.
• refundAllItems, refundAmount e refundLineItems, se viene chiesto il rimborso totale degli articoli, non è possibile specificare nè l'importo di rimborso parziale neè l'elenco degli articoli da rimborsare;
• All’interno di refundLineItems, alcune proprietà sono soggette a vincoli di coerenza logica:
  • Deve essere valida almeno una delle seguenti condizioni per ogni elemento:
    • refundLineTotally = true, oppure
    • quantity > 0, oppure
    • refundAmount > 0.
  • Non è ammessa la combinazione in cui refundLineTotally = false e quantity = 0; almeno uno dei due deve essere valorizzato.
  • Se refundLineTotally = false e refundAmount > 0, allora quantity deve essere maggiore di zero.

Le proprietà quantity e refundAmount per una riga ordine di refundLineItems devono invece essere impostate contemporaneamente, se impostate. La valuta del rimborso è quella dell'ordine del cliente che lo richiede.

Esempi Messaggi di Input

1. Rimborso parziale spedizione e rimborso righe ordine parziale, con una riga rimborsata totalmente, e l'altra per 1 quantità.

{
   "orderName":"#1061",
   "notifyCustomer": true,
   "reason": "Articoli danneggiati",
   "refundShippingAmount": "9.99",
   "refundLineItems": [
      {
         "sku": "135DFE",
         "refundLineTotally": true
      },
      {
         "sku": "136HJK",
         "quantity": 1,
         "refundAmount": "90.30"
      }
   ]
}

2. Rimborso parziale spedizione e rimborso totale righe ordine

{
   "orderName":"#1061",
   "notifyCustomer": false,
   "refundShippingAmount": "9.99",
   "refundAllItems": true
}

3. Rimborso totale spedizione e rimborso in testata righe ordine

{
   "orderName":"#1061",
   "notifyCustomer": true,
   "totalShippingRefund": true,
   "refundAmount": "349.99"
}