- The batch return file allows Merchants to post returns into the AvantLink transaction database.
- Batch return files should be scheduled to be imported on daily or weekly basis.
- Return records must be posted to the AvantLink system within 30 days of the original sale transaction date.
- Files will be uploaded via FTP to batch.avantlink.com, in the “returns” directory. (Contact email@example.com for FTP credentials).
- The batch file must match the EXACT specifications in order to work. So pay extra close attention to all the data that is being populated.
Merchant ID,Transaction/Order ID,Product ID/SKU,Return Item Amount,Return Item Quantity,Return Reason Code
Note: Please include a column header row in your files with the column headers exactly as shown below. The headers can be in any order which is why they need to match exactly.
Note: Return Item Quantity needs to be populated in order for the import to take.
Column Value Specifications:
|Merchant ID||integer||The Merchant ID supplied by AvantLink|
|Transaction/Order ID||string||The transaction or order ID from your e-commerce system.|
|Product ID/SKU||string||The return record Product ID or SKU from your e-commerce system. This must match the product ID/SKU provided with the datafeed file.|
|Return Item Amount||float||The return order per-item price, with no dollar sign or comma formatting (decimal places are allowed). By default, all currency values should be supplied as US dollars (USD).|
|Return Item Quantity||integer||The return order item quantity.|
|Return Reason Code||string||The reason the sale item is being reversed. Current codes are: ADJUSTMENT, CANCELED, FRAUD, RETURN. (any variation of these will cause an error, example: RETURNS will break the import)|
Note: special symbols (specifically $ signs) should not be included in the price column. Additionally, a space at the end of the price will also cause the import to stop.
File Naming Convention
We can accept CSV, or pipe-delimited text files for batch processing.
Pipe delimited ( .txt ): returns_[MERCHANT_ID]_Year_Month_Day.txt
Comma delimited ( .csv ): returns_[MERCHANT_ID]_Year_Month_Day.csv
If the file has been created and imported to the returns folder on the FTP server our system will pull it, import it, and then delete the file.
If you check your returns folder and the returns file is still there the next day, please contact firstname.lastname@example.org to have them enable the batch returns process on the back end.
If the file is deleted from the root folder but you're not seeing the updates via reporting, it's mostly likely an issue with the data and you should go through the file to make sure everything is up to the specifications, listed above, and then try again.
Example Data File