help center

| Submit or View Help Requests | Developer Docs |
|

Batch Modifications & Reversals File Parameters & Reason Codes

View the below tables 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. Remember that all files must be submitted in .CSV or XML formats.

Order-level accepted parameters

Query Parameter

Format

Required

Description

CustomerStatus

String (40)

Optional

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

ActionID

Integer

Yes, unless Oid is provided.

Numeric value that impact.com assigns to an action.

Oid

Alphanumeric (64)

Yes, unless ActionID is provided.

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

ActionTrackerID

Integer

Yes

Numeric value that Impact assigns to the Event Type that tracked the action.

Amount

Decimal (8,2)

Yes

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

Reason

String

Yes

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

Item-level accepted parameters

Query Parameter

Format

Required

Description

Category{i}

String

No

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

ActionID

Integer

Yes, unless Oid is provided.

Numeric value that impact.com assigns to an action.

Oid

Alphanumeric (64)

Yes, unless ActionID is provided.

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

ActionTrackerID

Integer

Yes

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

Amount{i}

Decimal (8,2)

Yes

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

Sku{i}

Alphanumeric (40)

Yes

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

Quantity{i}

Integer

Yes

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

Reason{i}

String

Yes

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

Reason codes

Code

Description

CONS_FRAUD

Consumer fraud

CONS_ERROR

Consumer error

ITEM_RETURNED

Item returned

ORDER_ERROR

Order error

ORDER_UPDATE

Order was updated

PUB_ACT_DISPUTE

Partner activity dispute

ADV_ACT_DISPUTE

Advertiser 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

Note

Passing a non-accepted value will result in the entry not processing and throwing an error. 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.