Order-Level Data

Conversion data reference

Parameter NameFormat (Size)DescriptionRequirementExample ValueNotes
OrderId || OidSTRING (64)Your unique identifier for the order associated with this conversion. For example, in a retail sale, this could be the Order ID your eCommerce engine assigns to the customer's order.RequiredT52324111211This value is always required when submitting conversions — the preferred parameter name is OrderId, however, Oid is still supported. Note that an OrderId value only needs to be unique to the event type (also known as the action tracker).
AmountDECIMAL (8,2)Total amount for the line item (quantity * price), pre-tax, pre-shipping and post-discount.Required if passing item-level details, otherwise optional; do not submit if using ItemPrice or ItemSubtotal1234.99In most cases, submit Quantity & Price in order for impact.com to accurately generate this value.
CurrencyCode || CurrencySTRING (3)The three character currency code of the purchase made. This is used to calculate exchange rates into funding and payment currencies if needed. Note that if this is not sent, your account's default currency will be used.OptionalUSDCurrencyCode is the preferred parameter name.
PaymentTypeSTRING (32) UTF-8This method of payment used for this conversion.OptionalCREDIT
OrderSubtotalDECIMALThe subtotal of the order before discounts, taxes, shipping, and any other costs.Optional49.99
OrderDiscountDECIMAL (12,2)For sales, this is the discount applied to the order overall. Amount is automatically subtracted from the order total on processing. If item amounts are used, this discount will be subtracted proportionally from each item amount sent in. Note that typically you will want to exclude shipping discounts from this field.Optional3.99
OrderShippingDECIMAL (14,2)Primarily used for retail sales. This is the cost of shipping for this conversion. Note that the total sale amount used for payout purposes will not include shipping costs.Optional9.99
OrderTaxDECIMAL (14,2)Primarily used for retail sales. This is the cost of tax for this conversion. Note that the total sale amount used for payout purposes will not include shipping costs.Optional8.99
OrderMarginDECIMAL (14,2)Primarily used for retail sales. This is the total margin made on the conversion (revenue less costs). Typically this is provided through the product catalog.Optional12.34
GiftPurchaseBOOLEANIf you're tracking gift purchases, you can submit true to mark the order in the conversion as a gift purchase. Submit false if the order isn't a gift purchase.Optionaltrue || false
LocationIdSTRING (64)Primarily used for accommodations, this is the unique identifier for the location specified in this conversion.OptionalSBHOTEL
LocationNameSTRING (64)Primarily used for accommodations, this is the name for the location specified in this conversion.OptionalFess Parker
LocationTypeSTRING (64) UTF-8Primarily used for accommodations, this is the category for the location specified in this conversion.OptionalHotel

Order-level template

CampaignIdActionTrackerIdOrderIdEventDateAmountCurrencyCodeClickId
11111234598765432038-01-19T00:26:05+00123.45USDZfXLH51WY5DghyMkWGJ7CpX3O0IyPqM2c5e3t5Z
11111234512345672038-01-19T00:29:51+0098.76USDr1NJgMzZnYtKETog6J5yVBCPi152BwWzlRXBaYk