> For the complete documentation index, see [llms.txt](https://integrations.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.impact.com/brand-api-reference/brand-api-reference-v13/reference/action-and-conversion-field-references/action-modification-and-reversal-field-references.md).

# 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](/brand-api-reference/brand-api-reference-v13/reference/action-and-conversion-field-references/conversion-submission-field-references.md) to submit new conversions in bulk.

| If you want to...                             | Use this method...                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| --------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Submit a manual, one-time file with no coding | ​[Email](https://help.impact.com/brand/what-would-you-like-to-learn-about/platform-features/submit-and-modify-conversion-data/submit-conversion-data/submit-conversion-data-via-ftp-or-email#before-you-start) batch processing or [upload file via FTP](https://help.impact.com/brand/what-would-you-like-to-learn-about/platform-features/submit-and-modify-conversion-data/batch-modify-conversion-data/submit-batch-modifications-and-reversals#upload-file-to-system-ftp-server)                                                                                                                                                                                                                 |
| Set up automated conversion reporting         | ​[Conversions](https://integrations.impact.com/brand-api-reference/reference/conversions/conversions) / [Actions](https://integrations.impact.com/brand-api-reference/reference/actions) API, [push file via FTP](https://help.impact.com/brand/what-would-you-like-to-learn-about/platform-features/submit-and-modify-conversion-data/batch-modify-conversion-data/submit-batch-modifications-and-reversals#upload-file-to-system-ftp-server), or [pull file via FTP](https://help.impact.com/brand/what-would-you-like-to-learn-about/platform-features/submit-and-modify-conversion-data/batch-modify-conversion-data/submit-batch-modifications-and-reversals#pull-file-from-your-own-ftp-server) |

## Action processing reference

Use these fields to [modify or reverse action data in bulk](https://help.impact.com/brand/what-would-you-like-to-learn-about/platform-features/submit-and-modify-conversion-data/batch-modify-conversion-data/submit-batch-modifications-and-reversals) 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.

<table><thead><tr><th>Field</th><th width="128">Level</th><th>Required?</th><th>Description</th><th>Editable?</th><th>Note for use</th><th>Format</th><th>Example</th></tr></thead><tbody><tr><td><code>ActionID</code></td><td>Order/Item</td><td>Conditionally Required</td><td>An action’s unique identifier, used to specify which action you want to modify.</td><td>Non-editable</td><td>Recommended when the deduplication window is short. At least one identifier path must be provided (<code>ActionID</code> or <code>OrderId/Oid</code> + <code>ActionTrackerId</code>).</td><td>Integer (10)</td><td>12345</td></tr><tr><td><code>Oid</code> / <code>OrderId</code></td><td>Order/Item</td><td>Conditionally Required</td><td>Value you assign to the order—typically an order ID or confirmation number.</td><td>Non-editable</td><td>Required when using <code>ActionTrackerID</code>. At least one identifier path must be provided (<code>ActionID</code> or <code>OrderId/Oid</code> + <code>ActionTrackerId</code>).</td><td>String (64)</td><td>T52324111211</td></tr><tr><td><code>ActionTrackerID</code></td><td>Order/Item</td><td>Conditionally Required</td><td>Value impact.com assigns to the Event Type that tracked the action.</td><td>Non-editable</td><td>Required when using <code>OrderId/Oid</code>. At least one identifier path must be provided (<code>ActionID</code> or <code>OrderId/Oid</code> + <code>ActionTrackerId</code>).</td><td>Integer (10)</td><td>98765</td></tr><tr><td><code>Amount</code>*</td><td>Order/Item</td><td>Conditionally Required</td><td>Total amount of the order/item, pre-tax, pre-shipping, and post-discount.</td><td>Editable</td><td>Set the new total amount for the order. If you modify <code>Quantity</code>, this field requires modification too.</td><td>Decimal (8,2)</td><td>1234.99</td></tr><tr><td><code>CustomerStatus</code></td><td>Order</td><td>Optional</td><td>The customer’s status at the time of conversion.</td><td>Editable</td><td>Set the customer’s status at the time of conversion (e.g., New).</td><td>String (30)</td><td>New</td></tr><tr><td><code>SKU</code>*</td><td>Item</td><td>Required</td><td>Unique stock-keeping unit (SKU) of the product.</td><td>Non-editable</td><td>Provide the SKU of the item you want to modify. Must be included for each item.</td><td>String (255)</td><td>ABC123</td></tr><tr><td><code>Quantity</code>*</td><td>Item</td><td>Optional</td><td>Quantity of the item that was purchased in the order.</td><td>Editable</td><td>Set the new quantity of items in the order.</td><td>Integer</td><td>1</td></tr><tr><td><code>Category</code>*</td><td>Item</td><td>Optional</td><td>Category for the product - can be automatically pulled if a product catalog has been uploaded.</td><td>Editable</td><td>Set the category of the item.</td><td>String (255)</td><td>Footwear</td></tr><tr><td><code>Reason</code>*</td><td>Order/Item</td><td>Required</td><td>Your reason for modifying the action data.</td><td>Editable</td><td>Provide a valid <a href="/spaces/wMLlMoFBtKJa8ptd3zaw/pages/grLBZqm6GXUeKWoVD923">reason code</a> for the modification. For item-level modifications, include a <code>Reason</code> for each item.</td><td>String</td><td><code>ITEM_RETURNED</code> (See supported values)</td></tr></tbody></table>

\*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.

{% hint style="info" %}
**Tip:** If you want to approve actions, *Approve* needs to be set up as a [custom disposition code](https://help.impact.com/brand/what-would-you-like-to-learn-about/platform-features/tracking/set-up-tracking/manage-disposition-codes). You can then submit the approval with its reason code as you would a modification.
{% endhint %}

### 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.

| Field             | Level      | Required?              | Description                                                                     | Editable?    | Note for use                                                                                                                                                                                                              | Format        | Example      |
| ----------------- | ---------- | ---------------------- | ------------------------------------------------------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------ |
| `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](https://help.impact.com/brand/what-would-you-like-to-learn-about/platform-features/tracking/set-up-tracking/manage-disposition-codes) 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.

{% hint style="warning" %}
**Warning:** If original order *Amount = 0*, leave *Amount* unchanged to avoid misclassifying as a modification.
{% endhint %}

### Additional optional fields <a href="#additional-optional-fields" id="additional-optional-fields"></a>

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        |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://integrations.impact.com/brand-api-reference/brand-api-reference-v13/reference/action-and-conversion-field-references/action-modification-and-reversal-field-references.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.