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
.
Query Parameter | Format | Required | Modifiable | Description |
---|---|---|---|---|
| String (40) | Optional for modifications. Do not include this parameter for reversals. | Yes | This can update the customer's status: |
| Integer | Required, unless | No | Unique identifier for the action, used to specify which action you intend to update. Using |
| Alphanumeric (64) | Required if Optional if | No | Value that the brand assigns to the order—typically an order ID or confirmation number. |
| Integer | Required if Optional if | No | Numeric value that impact.com assigns to the Event Type that tracked the action. |
| 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. |
| 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. |
Query Parameter | Format | Required | Modifiable | Description |
---|---|---|---|---|
| Integer | Yes, unless | No | Unique identifier for the action, used to specify which action you intend to update. Using |
| Alphanumeric (64) | Required if Optional if | No | Value that the advertiser assigns to the order—typically an order ID or confirmation number. |
| Integer | Required if Optional if | No | Numeric value that impact.com assigns to the Event Type that tracked the action.impact.com |
| 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. |
| 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. |
| Integer | Optional for modifications. Required for reversals. | Yes | For item-level actions, the modified quantity of items in the order. |
| String | Required for modifications. Do not include this parameter for reversals. | Yes | For item-level actions, the Category that the item is in. |
| 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. |
Code | Description |
---|---|
| Consumer fraud |
| Consumer error |
| Item was returned |
| Action is approved |
| Order error |
| Order was updated |
| Partner activity dispute |
| Brand activity dispute |
| Not in compliance with terms |
| Item is out of stock |
| Test action |
| Partner account deactivated |
| Credited to another partner |
| 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.