Setup & config
Here's how to set up and configure your Engage-Inretrn integration.
Requirements
For this integration you will need:
An active Inretrn license
An active Voyado Engage CXP and Omni license
An API key to access Engage from Inretrn
Setting up
The Engage integration is set up in Inretrn Admin under "Integrations". Here you'll specify the base API URL, your API key and if there are any other Engage contact types besides "Member" and "Contact" that Inretrn will need to deal with.
Customer profile enrichment
Inretrn tracks several KPIs for returns. These can be synced to Engage as contact attributes.
These attributes need to be set up in Engage and will be synced (created or updated) from Inretrn whenever a customer makes a return or when one of their specific KPIs are updated.
The KPIs are calculated using whatever group currency is configured in Inretrn.
Here are the contact attributes that need to be set up in Engage for this to work:
Alias | Datatype | Comment |
---|---|---|
easycomLevels | Dropdown | Levels set up in Inretrn; attribute values in Engage are:
|
easycomFirstOrderDate | Date | First order date |
easycomLastOrderDate | Date | Last order date |
easycomPiecesClaimed | Integer | Number of claimed items |
easycomPiecesReturned | Integer | Number of returned items |
easycomPiecesSold | Integer | Number of sold items |
easycomTrueProfit | Number | True profit |
easycomRevenue | Number | Revenue |
easycomCost | Number | Cost |
easycomClaimShare | Integer | Claim share (%) |
easycomReturnShare | Integer | Return share (%) |
easycomTrueProfitShare | Integer | True profit share (%) |
The results on the customer's contact card in Engage will then look like this:
Sending transactions (receipts)
Inretrn supports the sending of returns transaction that were created in the e-com to Engage. So if the e-com is missing returns, these can be synced to Engage directly from Inretrn.
If the currency used differs from the group currency, Inretrn will include the exchangerateToGroupCurrency attribute when it sends transactions. It will also include returnreason in the transaction call, which can be then used to perform segmentation in Engage.
The returnreason codes must be added in the Engage back-end (your Voyado team will take care of this):
Transactional emails
Inretrn can trigger transactional emails to be sent from Voyado Engage based on these statuses:
Return created (easycomReturnCreated)
Return approved (easycomReturnApproved)
These emails can include the following information:
Any complaints that were made with the return
Any items that where exchanged (the exchanged products are included as well)
Any product conditions that affected the repayment
This is an example payload for this kind of trigger:
{ "contact": { "matchKey": "example@easycom.com", "matchKeyType": "Email" }, "orderNumber": "EXAMPLE1234567", "orderStatus": "EasycomReturnCreated", "paymentStatus": "Paid", "createdDate": "2022-11-21T15:55:00.0000000+02:00", "shippingDate": "", "statusChangedDate": "", "storeId": "exampleshop.se", "language": "sv", "currency": "SEK", "exchangeRateToGroupCurrency": 1, "extraData": { "returnFreight": -69, "freight": 49, "transportServiceCode": "MYPACK_RETURN_QR", "returnLabelURL": "https://examplestore.blob.core.windows.net/documents/5445cd1e-aaa2-1234-8df1-ac900be14e6f.pdf" }, "totalGrossPrice": -1479, "totalTax": 0, "paymentMethods": [], "items": [ { "type": "RETURN", "sku": "224-835-1111-666-M", "quantity": -1, "grossPaidPrice": 1499, "taxAmount": 0, "taxPercent": 0, "description": "Silver-plated cuirass, medium", "imageUrl": "https://www.example.se/pub_images/original/224-835-1001-565-26887.jpg?extend=copy&width=1024&method=fit&height=1280&type=webp", "targetUrl": "http://www.example.se", "extraData": { "reasonCode": "Ångrat köp", "reasonCodeType": "Return", "exchange": 0, "exchangeSku": "", "exchangeDescription": "", "exchangeImageURL": "" }, "discounts": [] } ], "freightFee": { "value": 20, "tax": 0, "taxPercent": 0 }, "handlingFee": { "value": 0, "tax": 0, "taxPercent": 0 }, "totalRoundOff": { "value": 0, "tax": 0 } }
Migrating transactions
Inretrn can export existing return transaction to Engage. This is done in your Inretrn configuration area.