Batch Modifications & Reversals Reference

When modifying or reversing action data in bulk, start by downloading one of impact.com’s provided template files and replacing the example data with your own. When adding your own data, be sure to follow the guidelines in the relevant reference table to ensure your file submission is formatted correctly. Once your submission file is ready, you can resume with submitting your batch modifications / reversals file.

This reference article includes the most commonly used fields for batch modifications and reversals. To see a full, detailed reference including field descriptions, refer to Action & Conversion Field References.

See the references below to:

• Learn which fields to use in an FTP/SMTP batch modification or reversal
• Download template files with placeholder example data
• Understand which reason codes to apply and when

Order-level modifications

This is for when you want to update action data in bulk at the order level rather than an item level, e.g., change the order Amount for multiple orders.

Accepted parameters

Field	Required?	Editable?	Note
ActionID	Conditionally Required*	Non-editable	Providing this identifier is recommended when the deduplication window is short.
Oid / OrderId	Conditionally Required*	Non-editable	Providing this identifier is required when using ActionTrackerId.
ActionTrackerID	Conditionally Required*	Non-editable	Providing this identifier is required when using OrderId/Oid.
Amount	Optional	Editable	Set the new total amount for the order.
currencyCode	Optional	Editable	Set the revenue currency of the action. Defaults to your impact.com account currency if not provided.
CustomerStatus	Optional	Editable	Set the customer’s status at the time of conversion, e.g., NEW / EXISTING.
Note	Optional	Editable	General field for event-level reporting purposes. If empty on the original conversion, submitting a value inserts it. Accepted only once per action — submit any other field changes in the same request.
LocationId	Optional	Editable	Primarily used for accommodations, this is the unique identifier for the location specified in this conversion. If empty on the original conversion, submitting a value inserts it.
LocationName	Optional	Editable	Primarily used for accommodations, this is the name for the location specified in this conversion. If empty on the original conversion, submitting a value inserts it.
GiftPurchase	Optional	Editable	Set to true to mark the order as a gift purchase, or false to unmark it. If empty on the original conversion, submitting a value inserts it.
Text1–Text50	Optional	Editable	General text fields that accept strings of any text data you want to send (Text1 through Text50). If empty on the original conversion, submitting a value inserts it. Accepted only once per action — submit any other field changes in the same request.
Reason	Required	Editable	Provide a valid reason code for the modification.

*At least one identifier path must be provided, i.e., either ActionId or (*OrderId/Oid *+ ActionTrackerId)

Template files

• Order-level modifications template
• Order-level approvals template

Order-level reversals

This is for when you want to reverse partner-driven actions in bulk at the order level rather than an item level, e.g., reverse multiple orders.

Accepted parameters

Field	Required?	Editable?	Note
ActionID	Conditionally Required*	Non-editable	Providing this identifier is recommended when the deduplication window is short.
Oid / OrderId	Conditionally Required*	Non-editable	Providing this identifier is required when using ActionTrackerId.
ActionTrackerID	Conditionally Required*	Non-editable	Providing this identifier is required when using OrderId/Oid.
Amount	Conditionally Required**	Editable	Set to 0 to reverse order, unless original amount = 0**
Reason	Required	Editable	Provide a valid reason code for the reversal.

*At least one identifier path must be provided, i.e., either ActionId or (OrderId/Oid + ActionTrackerId)

**If original Amount = 0, leave Amount unchanged to avoid misclassifying as a modification.

Template files

• Order-level reversals template

Item-level modifications

This is for when you want to update action data in bulk at the item level rather than an order level, e.g., change the Amount for multiple items in an order.

Accepted parameters

Field	Required?	Editable?	Note
ActionID	Conditionally Required*	Non-editable	Providing this identifier is recommended when the deduplication window is short.
Oid / OrderId	Conditionally Required*	Non-editable	Providing this identifier is required when using ActionTrackerId.
ActionTrackerID	Conditionally Required*	Non-editable	Providing this identifier is required when using OrderId/Oid.
SKU**	Required	Non-editable	Provide the SKU value of the item you want to modify.
Amount**	Conditionally Required	Editable	Set the new item amount, i.e., price*quantity. If you modify the quantity, this field requires modification too.
Quantity**	Optional	Editable	Set the new quantity of items in the order.
Category**	Optional	Editable	Set the category of the item.
Reason**	Required	Editable	Provide a valid reason code for the reversal.

*At least one identifier path must be provided, i.e., either ActionId or (OrderId/Oid + ActionTrackerId)

**These fields must be included for each item you modify. The identifier fields are only included once per order.

Template files

• Item-level modifications template
• Item-level approvals template

Item-level reversals

This is for when you want to reverse action data in bulk at the item level rather than an order level, e.g., reverse multiple items in an order.

Accepted parameters

Field	Required?	Editable?	Note
ActionID	Conditionally Required*	Non-editable	Providing this identifier is recommended when the deduplication window is short.
Oid / OrderId	Conditionally Required*	Non-editable	Providing this identifier is required when using ActionTrackerId.
ActionTrackerID	Conditionally Required*	Non-editable	Providing this identifier is required when using OrderId/Oid.
SKU**	Required	Non-editable	Provide the SKU value of the item you want to modify.
Amount**	Conditionally Required	Editable	Set the new item amount, i.e., price*quantity. If you modify the quantity, this field requires modification too.
Quantity**	Optional	Editable	Set the new quantity of items in the order.
Reason**	Required	Editable	Provide a valid reason code for the modification.

*At least one identifier path must be provided, i.e., either ActionId or (OrderId/Oid + ActionTrackerId)

**These fields must be included for each item you modify. The identifier fields are only included once per order.

Template files

• Item-level reversals template

SKU O7427540 appears twice in this example because one line is reversing (Amount=0) and one is modifying (Amount=15).

Note: If you anticipate having duplicate OrderIds and opt to use the combination of OrderId + ActionTrackerId, impact.com applies your update to the newest ActionId by default. Use the old ActionId if you want to apply the update to the older ActionId.

Reason Codes

Every time you modify or reverse action data, you must provide a reason. Use the relevant reason code below to explain why the action is being updated.

Warning: Passing a non-accepted value will result in the entry not being processed and returning an error instead. If you need custom reason codes, reach out to your CSM or contact support to discuss Disposition Codes.

Code	Description
CONS_FRAUD	Consumer fraud
CONS_ERROR	Consumer error
ITEM_RETURNED	Item was returned
APPROVED	Action is approved Note: If you’re trying to approve actions, Approve needs to be set up as a custom disposition code.
ORDER_ERROR	Order error
ORDER_UPDATE	Order was updated
PUB_ACT_DISPUTE	Partner activity dispute
ADV_ACT_DISPUTE	Brand activity dispute
NOT_COMPLIANCE_TERMS	Not in compliance with terms
ITEM_OUT_OF_STOCK	Item is out of stock
TEST_ACTION	Test action
PARTNER_NOT_ACTIVE	Partner account deactivated
CREDITED_DIFFERENT_MP	Credited to another partner
OTHER	Other reason