The table provides sample JSON schemas for TLog exports. When mapping your TLog using the JSON format, follow the schema outlined in the table to ensure compatibility with your downstream systems.
In the reference documentation, a JSON property is identified as a collection (List/Array) if, upon expansion, it displays Any of VARIABLES, indicating it contains a collection of that specified variable.
Tip
| File | JSON Field | Order Activity Log |
|---|---|---|
| Sale Transactions | ||
| Single Item Sale Transaction involving the sale of one specific item in an order | orderProductList | orderActivityLog.TransactionData.orderId |
| Offline Single Item Offline transaction involving the sale of one specific item in an order | orderProductList | N/A |
| Multi Item Sale Transaction involving the sale of multiple items in an order | orderProductList | N/A |
| Sale With Customer Transaction associated with a specific customer | customerProfile | orderActivityLog.transactionData.profile |
| Promotions and Discounts | ||
| Employee Discount Transaction with employee discount applied | orderProductList.priceAdjustments | orderActivityLog.transactionData.productList.productPriceAdjustment |
| Item Level Discount Discount applied to specific items in an order | orderProductList.priceAdjustments | orderActivityLog.transactionData.productList.productPriceAdjustment |
| Transaction Level Discount Discount applied to the total cost of a transaction | orderProductList.priceAdjustments transactionDiscountAmount | orderActivityLog.transactionData.productList.productPriceAdjustment Additional Field: “priceAdjustmentType”: “TRANSACTION_DISCOUNT” |
| Single Use Promotion Code Promotional code used once to apply discount to cart | coupons | N/A |
| Promotion Promotion applied to items or transactions | orderProductList.priceAdjustments | orderActivityLog.transactionData.productList.productPriceAdjustment Additional Field: “priceAdjustmentType”: “PROMOTION” |
| Gift Card Management | ||
| Purchase Gift Card Transaction with a gift card purchase | N/A | N/A |
| Issue With Loading Gift Cards Transaction with issues encountered when adding value to gift cards | orderProductList.productClass orderProductList.serialNumber | orderActivityLog.transactionData.productList.productClass |
| Notes and Adjustments | ||
| Item Level Note Transaction with notes applied to individual items | orderProductList.notesList | orderActivityLog.transactionData.productList.notesList |
| Order Level Note Transaction with notes applied to the entire order | notesList | N/A |
| Split Sales Attribution Transaction with sales attribution split among different employees | orderProductList.salesAssociateAttribution | orderActivityLog.transactionData.tenders |
| Tax and Billing | ||
| Tax Exempt Transaction with items that are not subjected to sales tax | taxExemptions | orderActivityLog.transactionData.taxExemptions |
| Billing Transaction with a recorded billing address | billingAddress | N/A |
| File | JSON Field | Order Activity Log |
|---|---|---|
| Charge & Send In-store omni transaction | fulfillmentType fulfillmentSubType shippingAddress billingAddress | N/A |
| Ship From Store Ship to home fom current store omni transaction | fulfillmentType fulfillmentsubtype shippingAddress | N/A |
| File | JSON Field | Order Activity Log |
|---|---|---|
| Cash Payment Transaction completed with cash | tenders.paymentMethod tenders.cardType | orderActivityLog.transactionData.tenders Additional Field: “paymentMethod”: “Cash” |
| Credit Card Payment Transaction completed with credit card | tenders.paymentMethod tenders.cardType fundingSource | orderActivityLog.transactionData.tenders Additional Field: “paymentMethod”: “CreditCard “cardType”: |
| Debit Card Payment Transaction completed with debit card | tenders.paymentMethod tenders.cardType fundingSource | orderActivityLog.transactionData.tenders Additional Field: “paymentMethod”: “CreditCard “cardType”: |
| Gift Card Payment Transaction completed with gift card | tenders.paymentMethod tenders.cardType fundingSource | orderActivityLog.transactionData.tenders Additional Field: “paymentMethod”: “GiftCard” |
| Tap to Pay Transaction completed with Tap to Pay | tenders.paymentMethod tenders.cardType fundingSource | orderActivityLog.transactionData.tenders |
| In-Store Pay By Link Transaction completed with in-store pay by link | tenders.paymentMethod tenders.cardType fundingSource | orderActivityLog.transactionData.tenders |
| Remote Pay By Link Transaction completed with remote pay by link | tenders.paymentMethod tenders.cardType fundingSource | orderActivityLog.transactionData.tenders |
| Multi-Tender Transaction completed with more than one type of payment method | tenders.paymentMethod tenders.cardType fundingSource | orderActivityLog.transactionData.tenders |
| Miscellaneous Payment (Goodwill) Transaction completed with a miscellaneous type of Goodwill | tenders.paymentMethod tenders.cardType fundingSource | N/A |
| Miscellaneous Payment (Deposit) Transaction completed with a miscellaneous type and a deposit | tenders.paymentMethod tenders.cardType fundingSource | N/A |
| File | JSON Field | Order Activity Log |
|---|---|---|
| Even Exchange (original, exchange) Transaction where an item is exchanged for another item of equal value, with no additional payment or refund | N/A | orderActivityLog.transactionData.transactionType originalOrderId |
| Exchange With Extra Payment (original, exchange) Transaction where an item is exchanged for another item of higher value, and the customer pays the difference | N/A | orderActivityLog.transactionData.transactionType originalOrderId |
| Exchange With Refund (original, exchange) Transaction where an item is exchanged for another item of lower value, and the customer receives a refund for the difference | N/A | orderActivityLog.transactionData.transactionType originalOrderId |
| Return (gift card cash out, multi-item, single item) Transaction where a customer returns an item and receives a refund or credit | returnProductList | orderActivityLog.transactionData.returnProductList.productId |
| Unreferenced Even Exchange (original, new order) Even exchange transaction that is not linked to a specific previous purchase or reference number | N/A | orderActivityLog.transactionData.transactionType originalOrderId returnProductList tenders.copiedFromOrderId noReceiptReturn |
| Unreferenced Return (exchange, return) Return transaction that is not linked to a specific previous purchase or reference number | returnProductList | N/A |
j
