Help Center

| Submit or View Help Requests | Developer Docs |

View desktop instructions
View mobile app instructions
Batch Modifications & Reversals File Parameters & Reason Codes

View the tables below to see which fields can be used in an FTP/SMTP batch modification or reversal. Reason codes (a required value) can also be found below.

Things to keep in mind

  • All files must be submitted in .CSV or XML formats.

  • No new data points can be added to existing transactions.

  • Any parameters not included in the list below are not modifiable.

Note: If you anticipate having duplicate Oid / OrderId's and opt to use the combination of Oid / OrderId + ActionTrackerId for modifications or reversals, impact.com applies it to the newest ActionId. Use the old ActionId if you intend to apply the modification against the older ActionId.

Order-level accepted parameters

Query Parameter

Format

Required

Modifiable

Description

CustomerStatus

String (40)

Optional for modifications.

Do not include this parameter for reversals.

Yes

This can update the customer's status: NEW or EXISTING.

ActionID

Integer

Required, unless Oid / OrderId and ActionTrackerId are provided.

No

Unique identifier for the action, used to specify which action you intend to update.

Using ActionId for reversals or modifications is recommended if you have a short deduplication window.

Oid / OrderId

Alphanumeric (64)

Required if ActionTrackerId is used.

Optional if ActionId is used.

No

Value that the brand assigns to the order—typically an order ID or confirmation number.

ActionTrackerID

Integer

Required if OrderId or Oid is used.

Optional if ActionId is used.

No

Numeric value that impact.com assigns to the Event Type that tracked the action.

Amount

Decimal (8,2)

Required for modifications.

Set to 0 for reversals, unless the original Amount = 0.

Yes

Set the new amount of the order. Set to 0 to reverse the action.

Reason

String

Required for modifications and reversals.

Yes

Reason code for the modification or reversal—refer to the reason codes table to select one that applies.

Important: For reversals where the original action Amount = 0, avoid changing the Amount parameter to 0 to reverse it as this could register as a modification instead, and the action won't be reversed.

Item-level accepted parameters

Query Parameter

Format

Required

Modifiable

Description

ActionID

Integer

Yes, unless Oid / OrderId and ActionTrackerId are provided.

No

Unique identifier for the action, used to specify which action you intend to update.

Using ActionId for reversals or modifications is recommended if you have a short deduplication window.

Oid / OrderId

Alphanumeric (64)

Required if ActionTrackerId is used.

Optional if ActionId is used.

No

Value that the advertiser assigns to the order—typically an order ID or confirmation number.

ActionTrackerID

Integer

Required if OrderId or Oid is used.

Optional if ActionId is used.

No

Numeric value that impact.com assigns to the Event Type that tracked the action.impact.com

Sku{i}

Alphanumeric (40)

Required for modifications and reversals.

No

For item-level actions, the SKU value assigned to an item as specified in the SKU list uploaded to impact.com.

Amount{i}

Decimal (8,2)

Required for modifications.

Set to 0 for reversals, unless the original Amount = 0.

Yes

Set the new amount of the order. Set to 0 to reverse the action.

Quantity{i}

Integer

Optional for modifications.

Required for reversals.

Yes

For item-level actions, the modified quantity of items in the order.

Category{i}

String

Required for modifications.

Do not include this parameter for reversals.

Yes

For item-level actions, the Category that the item is in.

Reason{i}

String

Required for modifications and reversals.

Yes

Reason code for the modification or reversal — refer to the Reason Codes table below to select one that applies.

Reason codes

Code

Description

CONS_FRAUD

Consumer fraud

CONS_ERROR

Consumer error

ITEM_RETURNED

Item was returned

APPROVED

Action is approved

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

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.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.