Return Assistant Extractions

The extraction system delivers additional extractions if the Return Assistant (Return Calculator) is activated for your application. The Return Assistant is a feature of the payment product that helps the payment users select and return ordered goods by recognizing purchased items.

If the Return Assistant feature is activated for your application, the Gini extraction system additionally delivers compound extractions and specific extractions of the Return Assistant.


Available compound extractions

A compound extraction describes a group of extractions. It represents the line items recognized on an invoice and is delivered by the extraction system, provided the Return Assistant feature is activated.

Name

Description

Children

Children Description

Entity

Name

Description

Children

Children Description

Entity

lineItems

Invoice line items describe the details of purchased items.

artNumber

article number

text

 

 

baseGross

gross amount of 1 unit

amount

 

 

description

description of the item

text

 

 

position

position of the item

text

 

 

quantity

quantity in the units of the item

numeric

//compound extractions example { "compoundExtractions": { "lineItems": [ { "baseGross": { "entity": "amount", "value": "19.99:EUR", "box": { "top": 355.83, "left": 525.17, "width": 38.92000000000007, "height": 10.0, "page": 1 } }, "description": { "entity": "text", "value": "T-Shirt black, XL", "box": {... } }, "quantity": { "entity": "number", "value": "2", "box": {... } } }, { "artNumber": { "entity": "text", "value": "kWh", "box": {... } }, "baseGross": { "entity": "amount", "value": "14.99:EUR", "box": {... } }, "description": { "entity": "text", "value": "Socks, white 43-46", "box": {... } } } ] } }

Available specific extractions

Name

Description

Entity

Candidates

shipment-addon

The amount of a shipment cost.

amount

n/a

discount-addon

The amount of a discount.

amount

n/a

giftcard-addon

The amount of a discount issued in a form of a giftcard.

amount

n/a

other-discounts-addon

The total sum of all additional discounts.

amount

n/a

other-charges-addon

The total sum of all additional charges.

amount

n/a

//specific Return Assistant extractions { "amountsAreConsistent": { "entity": "text", "value": "true" }, "shipment-addon": { "entity": "amount", "value": "5.00:EUR" }, "discount-addon": { "entity": "amount", "value": "-5.00:EUR" }, "giftcard-addon": { "entity": "amount", "value": "1.00:EUR" }, "other-discounts-addon": { "entity": "amount", "value": "-1.00:EUR" }, "other-charges-addon": { "entity": "amount", "value": "1.00:EUR" } }

Return reasons

In addition to line items, the extraction system delivers a set of return reasons. A return reason represents a possible reason for the return of a line item and its subsequent refund that a user chooses during the selection/deselection of the line item. The delivered reasons depend on the domain of the retailer, that is they differ depending on whether it's a fashion or a tech shop.

//return reasons example { "extractions": { "...": "..." }, "compoundExtractions": { "...": "..." }, "candidates": { "...": "..." }, "returnReasons": [ { "de": "Anders als im Bild", "en": "Looks different from site image", "id": "r1" }, { "de": "Schlechte Qualität", "en": "Poor quality", "id": "r2" }, { "de": "Defekt", "en": "Defect", "id": "r3" }, { "de": "Passt nicht richtig", "en": "Doesn't suit me", "id": "r4" }, { "de": "Falsches Produkt empfangen", "en": "Received wrong item", "id": "r5" }, { "de": "Paket wurde beschädigt", "en": "Parcel was damaged", "id": "r6" }, { "de": "Lieferung zu spät angekommen", "en": "Arrived too late", "id": "r7" } ] }