JSON Sample Payloads & Schemas

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.

tip: 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.

Basic Orders

File JSON Field Order Activity Log
Sale Transactions
Single Item Sale <br>Transaction involving the sale of one specific item in an order orderProductList orderActivityLog.TransactionData.orderId
Offline Single Item <br>Offline transaction involving the sale of one specific item in an order orderProductList N/A
Multi Item Sale <br>Transaction involving the sale of multiple items in an order orderProductList N/A
Sale With Customer <br>Transaction associated with a specific customer customerProfile orderActivityLog.transactionData.profile
Promotions and Discounts
Employee Discount <br>Transaction with employee discount applied orderProductList.priceAdjustments orderActivityLog.transactionData.productList.productPriceAdjustment
Item Level Discount <br>Discount applied to specific items in an order orderProductList.priceAdjustments orderActivityLog.transactionData.productList.productPriceAdjustment
Transaction Level Discount <br>Discount applied to the total cost of a transaction orderProductList.priceAdjustments transactionDiscountAmount orderActivityLog.transactionData.productList.productPriceAdjustment <br>Additional Field: "priceAdjustmentType": "TRANSACTION_DISCOUNT"
Single Use Promotion Code <br>Promotional code used once to apply discount to cart coupons N/A
Promotion <br>Promotion applied to items or transactions orderProductList.priceAdjustments orderActivityLog.transactionData.productList.productPriceAdjustment <br>Additional Field: "priceAdjustmentType": "PROMOTION"
Gift Card Management
Purchase Gift Card <br>Transaction with a gift card purchase N/A N/A
Issue With Loading Gift Cards <br>Transaction with issues encountered when adding value to gift cards orderProductList.productClass orderProductList.serialNumber orderActivityLog.transactionData.productList.productClass
Notes and Adjustments
Item Level Note <br>Transaction with notes applied to individual items orderProductList.notesList orderActivityLog.transactionData.productList.notesList
Order Level Note <br>Transaction with notes applied to the entire order notesList N/A
Split Sales Attribution <br>Transaction with sales attribution split among different employees orderProductList.salesAssociateAttribution orderActivityLog.transactionData.tenders
Tax and Billing
Tax Exempt <br>Transaction with items that are not subjected to sales tax taxExemptions orderActivityLog.transactionData.taxExemptions
Billing <br>Transaction with a recorded billing address billingAddress N/A

Omni Orders

File JSON Field Order Activity Log
Charge & Send <br>In-store omni transaction fulfillmentType fulfillmentSubType shippingAddress billingAddress N/A
Ship From Store <br>Ship to home fom current store omni transaction fulfillmentType fulfillmentsubtype shippingAddress N/A

Tender Payments

File JSON Field Order Activity Log
Cash Payment <br>Transaction completed with cash tenders.paymentMethod tenders.cardType orderActivityLog.transactionData.tenders <br>Additional Field: "paymentMethod": "Cash"
Credit Card Payment <br>Transaction completed with credit card tenders.paymentMethod tenders.cardType fundingSource orderActivityLog.transactionData.tenders <br>Additional Field: "paymentMethod": "CreditCard "cardType":
Debit Card Payment <br>Transaction completed with debit card tenders.paymentMethod tenders.cardType fundingSource orderActivityLog.transactionData.tenders <br>Additional Field: "paymentMethod": "CreditCard "cardType":
Gift Card Payment <br>Transaction completed with gift card tenders.paymentMethod tenders.cardType fundingSource orderActivityLog.transactionData.tenders <br>Additional Field: "paymentMethod": "GiftCard"
Tap to Pay <br>Transaction completed with Tap to Pay tenders.paymentMethod tenders.cardType fundingSource orderActivityLog.transactionData.tenders
In-Store Pay By Link <br>Transaction completed with in-store pay by link tenders.paymentMethod tenders.cardType fundingSource orderActivityLog.transactionData.tenders
Remote Pay By Link <br>Transaction completed with remote pay by link tenders.paymentMethod tenders.cardType fundingSource orderActivityLog.transactionData.tenders
Multi-Tender <br>Transaction completed with more than one type of payment method tenders.paymentMethod tenders.cardType fundingSource orderActivityLog.transactionData.tenders
Miscellaneous Payment (Goodwill) <br>Transaction completed with a miscellaneous type of Goodwill tenders.paymentMethod tenders.cardType fundingSource N/A
Miscellaneous Payment (Deposit) <br>Transaction completed with a miscellaneous type and a deposit tenders.paymentMethod tenders.cardType fundingSource N/A

Returns and Exchanges

File JSON Field Order Activity Log
Even Exchange (original, exchange) <br>Transaction where an item is exchanged for another item of equal value, with no additional payment or refund N/A orderActivityLog.transactionData.transactionType <br>originalOrderId
Exchange With Extra Payment (original, exchange) <br>Transaction where an item is exchanged for another item of higher value, and the customer pays the difference N/A orderActivityLog.transactionData.transactionType <br>originalOrderId
Exchange With Refund (original, exchange) <br>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 <br>originalOrderId
Return (gift card cash out, multi-item, single item) <br>Transaction where a customer returns an item and receives a refund or credit returnProductList orderActivityLog.transactionData.returnProductList.productId
Unreferenced Even Exchange (original, new order) <br>Even exchange transaction that is not linked to a specific previous purchase or reference number N/A orderActivityLog.transactionData.transactionType <br>originalOrderId <br>returnProductList <br>tenders.copiedFromOrderId <br>noReceiptReturn
Unreferenced Return (exchange, return) <br>Return transaction that is not linked to a specific previous purchase or reference number returnProductList N/A
<!-- ## Unreferenced attachments: - gift_card_cash_out_json - single_item_return_json - multi_item_return_json - original_json - new-order_json - unreferenced_return_json - unreferenced_exchange_json - offline_single_item_sale_json - employee_discount_json - item_level_discount_json - single_item_sale_json - multi_item_sale_json - sale_with_customer_json - transaction_level_discount_json - single_use_promo_code_json - promotion_json - purchase_gift_card_json - issueload_gift_card_json - item_level_note_json - order_level_note_json - split_sales_attribution_json - tax_exempt_json - chargesend_json - shipfromstore_json - cash_payment_json - credit_card_payment_json - debit_card_payment_json - gift_card_payment_json - taptopay_json - instorepaybylink_json - remotepaybylink_json - split_payment_json - original_sale_json - misc_paymentgoodwill_json - misc_paymentdeposit_json - exchange_json - original_sale_json - exchange_json - exchange_json - original_sale_json - billing_json -->