Return RMAs

Return RMAs is when there is created a pre-advice in TRAEDE to indicate that goods are expected to be returned to the warehouse. Once returned the RMA will be received - similarly to how a PO is received. Once received TRAEDE will issue a credit note to the customer. Read more under Recommended data flow

The return object

Parameter	Required	Default	Description
rma	Yes		The RMA of the return
status	Yes		The status of the return. Possible values: open, approved, received, credited
customer_number	Yes		The customer number of the return
customer	Yes		The name of the customer of the return
customer_meta	Yes	{}	An object with {"key": "value"} with custom meta data of the return. See custom fields for more information
customer_vat_number	Yes		The VAT number of the customer
currency	Yes		The currency of the return
notes		null	Optionally some notes to the return delivery
return_meta	object	{}	An object with {"key": "value"} with custom meta data of the return. See custom fields for more information
created_at	Yes
updated_at	Yes
lines	Yes		Array of object lines

Lines

Parameter	Required	Default	Description
product_name	Yes		The name of the product. This is the name of the product without attributes (Color, Size, etc.)
item_number	Yes		The item number of the product. NOTE: This is the number on the product-level, not variant-level. For variant-level refer to sku
attributes	Yes		An object with {"key": "value"} with the attributes of the variant. This will be Colors, Sizes, etc.
full_name	Yes		The name of the product plus its attributes. Use this for delivery notes and packing lists
sku	Yes		The unique identifier of this specific variant. Use this for identification in your WMS
ean		null	The EAN code of this variant
country_of_origin		null	Country of origin of the product. This is given as a 2-letter ISO code (DK, DE, etc.)
composition		null	The composition of the product (materials)
hs_tariff_code		null	The HS Tariff Code of the product
returned	Yes	0	The number of pieces that was received at the warehouse
expected_quantity	Yes		The number of pieces that is expected to be received on the return delivery

Get returns

Endpoint: GET /3pl/returns

Available properties for filtering: customer_id, created_at, updated_at

caution

It is recommended to use the Export version of this API to get returns out of TRAEDE. The export version will allow you to easily keep track of returns you have already exported and only serve you with new returns.

Data of response

Parameter	Required	Default	Description
returns.*	Yes		An array of Return RMA
total	Yes		The total number of returns

Export returns

Endpoint: GET /3pl/returns/export

This is a version of the GET returns API that is designed to be used for exporting returns to a WMS system. It is recommended to read our Introduction to the Export system to get a better understanding of how the export system works. Note this endpoint is different than the Export Returns API. In this endpoint the data is formatted in the same manner as the 3PL API GET returns endpoint. In the normal returns API the data is normalized. It is recommended to use this endpoint instead of the normal GET returns endpoint, since it's easier to use.

You can add a date+time to the query string using the parameter not_exported_since in return to re-export returns that have already been exported

Available properties for filtering: created_at, updated_at (NOTE: These filters have to be added using our Filters Syntax, however system_id and not_export_since should be added as a normal query string parameter)

The endpoint will fetch all returns that have not been exported yet

Available query parameters

Parameter	Data type	Required	Default	Description
system_id	string	Yes		A string identifying the system the returns should be exported to. This is used so returns can be exported to multiple systems.
not_exported_since	datetime (UTC)		Current time	Add this to re-export returns that have already been exported. Note the timezone should be UTC
include_drafts	integer		0	Export draft RMAs. 0 = only export non-draft RMAs. 1 = also include draft RMAs in export
include_received	integer		0	Export already received RMAs. 0 = only export non-received RMAs. 1 = also include received RMAs in export
filter_groups	Array<Filters>			Optional filters to add. See which filters are available above

Data of response

Parameter	Required	Default	Description
returns.*	Yes		An array of object 3PL API return)

Receiving a return

Marking a return as received

Endpoint: POST /3pl/returns/receive

Parameter	Required	Default	Description
return	Yes		Object of return

Return

Parameter	Required	Default	Description
rma	Yes		The identifier of the return delivery
lines	Yes		Array of object lines

Delivery note lines

Parameter	Required	Default	Description
sku	Yes, if no ean is given		The SKU of the line
ean	Yes, if no sku is given		The EAN of the line
received_quantity	Yes		The number of pieces that were received

Example

POST /3pl/returns/receive

{
  "return": {
    "rma": "1000-1",
    "lines": [
      {
        "sku": "1000-Black-S",
        "received_quantity": 10
      },
      {
        "sku": "1000-Black-M",
        "received_quantity": 10
      }
    ]
  }
}

Mark return as exported

caution

NOTE It is highly recommended to read our Export Returns guide on how the Export API works

Endpoint: POST /3pl/returns/mark-as-exported

Parameter	Data type	Required	Default	Description
returns	Array<Returns that have been exported>	Yes		Returns that have been exported. You can at a max mark 10 returns at a time

Returns that have been exported

Parameter	Data type	Required	Default	Description
return_id	int	Yes		The ID of the return that has been exported
system_id	string	Yes		A string identifying the system the returns should be exported to. This is used so returns can be exported to multiple systems.
note	string			Any notes regarding the sync you want to add. These will be displayed in the timeline of the return