Action Modification & Reversal Field References
Use this reference to identify the fields for modifying, reversing, or approving existing conversions in bulk. Use Conversion Submission Field References to submit new conversions in bulk.
Submit a manual, one-time file with no coding
Email batch processing or upload file via FTP
Set up automated conversion reporting
Conversions / Actions API, push file via FTP, or pull file via FTP
Action processing reference
Use these fields to modify or reverse action data in bulk after a conversion has occurred.
Modification fields
Use these fields to process modifications or approvals of partner-driven actions. You can apply changes at either the order level or item level, depending on whether the change affects the entire order or specific items within it.
ActionID
Order/Item
Conditionally Required
An action’s unique identifier, used to specify which action you want to modify.
Non-editable
Recommended when the deduplication window is short. At least one identifier path must be provided (ActionID or OrderId/Oid + ActionTrackerId).
Integer (10)
12345
Oid / OrderId
Order/Item
Conditionally Required
Value you assign to the order—typically an order ID or confirmation number.
Non-editable
Required when using ActionTrackerID. At least one identifier path must be provided (ActionID or OrderId/Oid + ActionTrackerId).
String (64)
T52324111211
ActionTrackerID
Order/Item
Conditionally Required
Value impact.com assigns to the Event Type that tracked the action.
Non-editable
Required when using OrderId/Oid. At least one identifier path must be provided (ActionID or OrderId/Oid + ActionTrackerId).
Integer (10)
98765
Amount*
Order/Item
Conditionally Required
Total amount of the order/item, pre-tax, pre-shipping, and post-discount.
Editable
Set the new total amount for the order. If you modify Quantity, this field requires modification too.
Decimal (8,2)
1234.99
CustomerStatus
Order
Optional
The customer’s status at the time of conversion.
Editable
Set the customer’s status at the time of conversion (e.g., New).
String (30)
New
SKU*
Item
Required
Unique stock-keeping unit (SKU) of the product.
Non-editable
Provide the SKU of the item you want to modify. Must be included for each item.
String (255)
ABC123
Quantity*
Item
Optional
Quantity of the item that was purchased in the order.
Editable
Set the new quantity of items in the order.
Integer
1
Category*
Item
Optional
Category for the product - can be automatically pulled if a product catalog has been uploaded.
Editable
Set the category of the item.
String (255)
Footwear
Reason*
Order/Item
Required
Your reason for modifying the action data.
Editable
Provide a valid reason code for the modification. For item-level modifications, include a Reason for each item.
String
ITEM_RETURNED (See supported values)
*When modifying multiple items in an order, these fields must be included for each item. The identifier fields are always included only once per order.
Tip: If you want to approve actions, Approve needs to be set up as a custom disposition code. You can then submit the approval with its reason code as you would a modification.
Reversal fields
Use these fields to process reversals of partner-driven actions. You can apply reversals at the order level to reverse an entire order, or at the item level to reverse individual items within an order.
ActionID
Order/Item
Conditionally Required
An action’s unique identifier, used to specify which action you want to modify.
Non-editable
Recommended when the deduplication window is short. At least one identifier path must be provided (ActionID or OrderId/Oid + ActionTrackerId).
Integer (10)
A12345
Oid / OrderId
Order/Item
Conditionally Required
Value you assign to the order—typically an order ID or confirmation number.
Non-editable
Required when using ActionTrackerID. At least one identifier path must be provided (ActionID or OrderId/Oid + ActionTrackerId).
String (64)
T52324111211
ActionTrackerID
Order/Item
Conditionally Required
Value impact.com assigns to the Event Type that tracked the action.
Non-editable
Required when using OrderId/Oid. At least one identifier path must be provided (ActionID or OrderId/Oid + ActionTrackerId).
Integer (10)
98765
Amount*
Order/Item
Conditionally Required
Total amount of the order/item, pre-tax, pre-shipping, and post-discount.
Editable
Adjust accordingly when reversing an item, or set to 0 to reverse the order (unless original order Amount = 0). If original order Amount = 0, leave Amount unchanged to avoid misclassifying as a modification.
Decimal (8,2)
0
SKU*
Item
Required
Unique stock-keeping unit of the product.
Non-editable
Provide the SKU value of the item you want to reverse.
String (255)
ABC123
Quantity*
Item
Optional
Quantity of the item that was purchased in the order.
Editable
Set the new quantity of items in the order.
Integer
0
Reason*
Order/Item
Required
Your reason for reversing the action data.
Editable
Provide a valid reason code for the reversal.
String
RETURN
*When reversing multiple items in an order, these fields must be included for each item. The identifier fields are always included only once per order.
Warning: If original order Amount = 0, leave Amount unchanged to avoid misclassifying as a modification.
Additional optional fields
While the fields above are those most commonly used in modifications and reversals, these additional fields can also be submitted when needed. Include them only when you want to modify them.
Field
Level
Description
Editable?
Format
Example
PaymentType
Order
Method of payment used for this conversion.
Editable
STRING (32)
CREDIT
OrderSubtotal
Order
Subtotal of the order before discounts, taxes, shipping, or other costs.
Editable
DECIMAL
49.99
OrderDiscount
Order
Total discount applied to the order. Automatically subtracted from the order total. Exclude shipping discounts.
Editable
DECIMAL (12,2)
3.99
OrderShipping
Order
Cost of shipping for this conversion. Total sale amount used for payout excludes shipping.
Editable
DECIMAL (14,2)
9.99
OrderTax
Order
Cost of tax for this conversion. Total sale amount used for payout excludes tax.
Editable
DECIMAL (14,2)
8.99
OrderMargin
Order
Total margin on the conversion (revenue less costs). Typically provided through product catalog.
Editable
DECIMAL (14,2)
12.34
GiftPurchase
Order
Indicates if the order is a gift purchase. Submit true for gift, false otherwise.
Editable
BOOLEAN
true/false
LocationId
Order
Unique identifier for the location in accommodations or similar contexts.
Editable
STRING (64)
SBHOTEL
LocationName
Order
Name of the location in accommodations or similar contexts.
Editable
STRING (64)
Fess Parker
LocationType
Order
Category of the location in accommodations or similar contexts.
Editable
STRING (64)
Hotel
ItemSubCategory
Item
Subcategory for the product, if applicable. Can be automatically pulled from a product catalog.
Editable
STRING (255)
Metalsmithing
Name
Item
Name of the product. Can be automatically appended via product catalog.
Editable
STRING (255)
Iron Anvil
ItemMpn
Item
Manufacturer part number (MPN) for the product. Can be pulled from a product catalog.
Editable
STRING (64)
123456789
ItemBrand
Item
Brand name of the product. Can be automatically pulled from a product catalog.
Editable
STRING (64)
Acme Corp
ItemDiscount
Item
Discount applied to each product of this type, not the entire line item.
Editable
DECIMAL (12,2)
2.99
ItemPromoCode
Item
Promotional code applied to this item. Does not work with unique tracking codes for partners.
Editable
STRING (255)
ITEMDISCOUNT10
ItemTotalDiscount
Item
Discount applied to this line item. Automatically subtracted from ItemSubTotal to determine final sale amount for payout/reporting.
Editable
DECIMAL (12,2)
49.99
ItemDeliveryType
Item
Type of delivery method for this item.
Editable
STRING (64)
EXPRESS
Last updated