Receive Data

Receive RMA exports via webhook, API or as a flat file (.csv or .tsv) to an SFTP server.

RMA Exports

We can provide an RMA export of returns data to your Warehouse Management System (WMS). This can be sent as a flat file (.csv or .tsv) to an SFTP server, or via webhook or an API connection.

The export contains the order number, tracking number, item ID/SKU, number of items, and return reasons. If additional information (for example: text feedback) is required, this data can be transferred as well.

In the following table, you can find a list of the data fields that are included in the RMA exports.

Field	Example	Type	Remarks
Return Details
consignmentNumber	ab938adnaduj38	string	Unique Return Portal ID.
trackingNumber	12345678	string	Tracking number of the parcel.
carrier	DHL	string	The carrier shipping the parcel.
orderNumber	12345678	string	Order number.
submittedDate	2024-12-10	date	Date the registration was submitted in format YYYY-MM-DD (ISO-8601).
returnMethod	inStoreReturn	string	Describes the method of return (for example: whether the return was made in store, picked up by couriers or dropped off at the post office).
Article Details
itemID	1223214343	string	Unique item ID.
SKU	1312321324	string	Unique stock keeping unit.
returnReason	Wrong item delivered	string	The selected return for reason.
problemDescription	Not what I expected	string	Descriptive reason why the item was returned.
compensationMethod	Exchange	string	Describes the method of compensation (for example: if a refund or exchange was issued).
returnQuantity	1	numeric	Quantity of returned item.
Customer Details
name	Bruce Wayne	string
street	Rue du Chardonay	string
zip	80339	string
state	Île-de-France	string
city	Paris	string
country	FR	string
phone	01569283	string
email	[email protected]	string

Sample RMA Exports

A sample .csv file can be found here as demonstration of the data structure:

544B

RMA-export-sample.csv

Open

A sample .json payload can be found here as demonstration of the data structure:

1KB

RMA onReturnRegistration payload sample.json

Open