Shop settlement (campaign or period)
The purpose of this report is to allow the retailer to allocate single-use coupon sales amount received to the central merchant account (HQ), to the stores where usage has happened.
For a given period the report will show single-use coupon codes that are: Used in the reporting period, Expired in the reporting period, Active at report period end (purchased before or on period end, but not used or expired at report end). The shop transaction report only shows transactions for a specific date/period (processing date), whereas the shop settlement report will show all used/expired/active codes for the date/period report generated.
Report details: “Code status”: “Used” or “Expired” – or “Active” if not used or expired. “Store ID”: If Code status = Used, column show StoreID, If Code status = Expired, column show StoreID of shopper’s local (home) store, If Code status = Active, column is blank. “DateTime”: show the local time of usage or expiration time. If Code status = Used, time of coupon usage, If Code status = Expired, expiration time, If Code status = Active, the column is blank.
| Parameter | Description | Data Type |
|---|---|---|
| Code | ID of the content that was issued as result of the purchase of the shop offer | Number |
| Code status | Current status of the coupon that was issued for this purchase: Active, Used, Expired | String |
| Store ID | Store identifier. If Code status is “Used”, this field indicates the ID of the store where the issued coupon was used. | Number |
| DateTime | Local time of usage. If Code status is “Used”, this field indicates date and time when the issued coupon was used. | String |
| DateTimeUTC | UTC time of usage. If Code status is “Used”, this field indicates date and time in UTC when the issued coupon was used. | String |
| Internal ID | Liquid Barcodes internal transaction id | String |
| Shop offer ID | Unique Id for the shop offer. Shop offer is a product customers can buy in the web shop / in app. | Number |
| Shop offer name | Name of the shop offer | String |
| Processing date | Local time and date when shop offer was purchased | String |
| Processing date UTC | Time and date in UTC when shop offer was purchased | String |
| User reference | Unique identifier of the user. | String |
| Merchant remuneration | Store compensation per purchased shop offer. | Number |
| Retail price | Price paid by customer for the shop offer. | Number |
| Currency | Currency | String |
| Payment ref | Transaction reference from the payment provider | String |
| Payment provider name | Name of the payment provider | String |
| Payment method | Description of the payment method used to buy the shop offer | String |
| Member ID | Unique identifier of the user. | String |
| Tax Amount | The tax amount paid by customer for the shop offer | Number |
| Promo code | Promo code used by customer on purchase of shop offer, giving a rebated price | String |