Help Center

| Submit or View Help Requests | Developer Docs |
| |

Set Up & Submit Batch Modifications & Reversals via FTP or Email

You can use our .csv template files below to help guide you in preparing a file with your modifications and reversals. The template file you need depends on whether you're tracking at the order level or item level, as each requires different fields. If you're unsure about which file to use, ask your CSM or (contact support).

Note

impact.com allows a maximum of 1000 modifications per action. If you need to make further modifications thereafter, contact support.

  1. Download the batch .csv template file relevant to your use case:

  2. Open the template file with a spreadsheet app (such as Microsoft Excel) or a text editor (such as Notepad or TextEdit).

  3. In the second row (i.e., the first row under the headers), start adding your action data.

    If you are using a spreadsheet app, add each data point in a separate cell.

    If you are using a text editor, use commas to separate each data point from the others.

    Important

    Make sure you're editing the cells in "Plain text" or "Text" format so that values aren't accidentally omitted.

  4. Save the file with an identifiable name, such as:

    Batch_Mods_Reversals_2020_02_12.csv

impact.com also supports .xml files for batch modifications & reversals. See the File examples section below to see an example of .xml files formatted for batch modifications & reversals.

Tip

Refer to Batch Modifications and Reversals File Parameters and Reason Codes to see which fields can be used in an FTP/SMTP batch modification or reversal.

Submit your data file

  1. From the left navigation bar, select ellipsis-v-solid.svg [Menu] → Settings.

  2. On the right, under Tracking, select Event Types.

  3. Select the name of the Event Type for which you want to submit batch modifications.

  4. Next to Returns Processing, select pencil-alt-solid.svg [Edit].

  5. Select Automate returns processing (advanced) and opt for your preferred upload method. Follow the steps below for each relevant method:

    Upload file to system FTP server

    1. Select Upload file to system FTP server.

    2. Select Email FTP Username and Password.

    3. Once you have received your FTP credentials, use an FTP client to connect to impact.com with the following info:

      ACC5CB5C-FE0F-479A-BEDD-1D8266CE0D70.png
    4. Once connected, upload your file to the main directory of the server.

      Important

      If you have not received the FTP credentials email, contact the person who created your impact.com account. Alternatively, contact support.

    Pull file from your own FTP server

    1. Select Pull file from your own FTP server.

    2. Enter the Server URLPort, and directory path to the batch modifications file on your FTP server. Enter the Username and Password that impact.com will use to connect to your FTP server.

    3. Select Save and continue.

    4. Upload your batch modifications file to the directory you specified above (point 6). impact.com attempts to connect and download files from your FTP server every 24 hours. Wait at least 24 hours for impact.com to download your file.

    Email file to system SMTP server

    1. Select Email file to system SMTP server, then copy your unique email address.

    2. Using any email client, send an email to the unique address with your batch modifications file as an attachment. (Only include the unique email address for the event type in the To: field. If you need to send this file to others, include them in the CC: line.)

      You can leave the subject field and message body blank.

  6. After a successful upload, go to the Review the file submission section below.

Review the file submission

Once you've sent your batch .csv or .xml file to impact.com, you can check its current status and if it was processed.

  1. From the left navigation bar, select ellipsis-v-solid.svg [Menu]Settings.

  2. In the left column, scroll to the Technical section and select File Submissions.

  3. Use the table to review recent file submissions that impact.com has received, including the current processing status.

File examples

Expand the examples below to see what the body of both a batch .csv and an .xml file would look like.

Order-level .csv

ActionTrackerID,Oid,Amount,Reason 
 16027,O7427540,0,ITEM_RETURNED16027,O8306075,30,CONS_ERROR
Item-level .csv

Reversing items requires two additional values (SKU and Quantity) compared to an order reversal.

ActionTrackerID,Oid,Amount,Sku,Quantity,Reason 
 10307,O7427540,0,SKU123,0,ITEM_RETURNED 10307,O7427540,15,SKU456,1,ORDER_ERROR 10307,O8306075,0,SKU7890,0,ITEM_RETURNED

See above that an Order ID is listed twice—this is because there are two different SKUs in the order (line 1 and line 2 respectively), one is being reversed and one is being modified. Notice the difference - one is being zeroed out (line 1) and the other is being changed to a new final value (line 2).

Note

  • You always need the correct SKU and OID when doing item-level modifications and reversals.

  • You can't modify an SKU (i.e., change an SKU) for item-level actions.

  • You can modify the quantity for item-level actions.

Order-level .xml

<?xml version="1.0" encoding="UTF-8"?><ActionReturnRequests xmlns="http://ws.impact.com/ws/definitions"><ActionReturnRequest><ActionTrackerId>16027</ActionTrackerId><Oid>O7427540</Oid><Amount>0.00</Amount><Reason>ITEM_RETURNED</Reason></ActionReturnRequest><ActionReturnRequest><ActionTrackerId>16027</ActionTrackerId><Oid>O8306075</Oid><Amount>30</Amount><Reason>CONS_ERROR</Reason></ActionReturnRequest></ActionReturnRequests>
Item-level .xml

Reversing items requires two additional values (SKU and Quantity) compared to an order reversal.

<?xml version="1.0" encoding="UTF-8"?><ItemActionReturnRequests xmlns="http://ws.impact.com/ws/definitions"><ItemActionReturnRequest><ActionTrackerId>10307</ActionTrackerId><Oid>O7427540</Oid><Items><Item><Amount>0.00</Amount><Sku>SKU123</Sku><Quantity>0</Quantity><Reason>ITEM_RETURNED</Reason></Item><Item><Amount>15.00</Amount><Sku>SKU456</Sku><Quantity>1</Quantity><Reason>ORDER_ERROR</Reason></Item></Items></ItemActionReturnRequest><ItemActionReturnRequest><ActionTrackerId>10307</ActionTrackerId><Oid>O8306075</Oid><Items><Item><Amount>0.00</Amount><Sku>SKU789</Sku><Quantity>0</Quantity><Reason>ITEM_RETURNED</Reason></Item></Items></ItemActionReturnRequest></ItemActionReturnRequests>

Did you find it helpful? Yes No

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