Skip to main content

Ad hoc returns

Ad hoc returns are primarily used for B2C orders, but can be used to create credit notes in TRAEDE for returns that have no RMA associated with it. For Ad hoc returns you simply state the original order number and the goods returned and then TRAEDE will issue a credit note. Read more under Recommended data flow

caution

In order to use Ad hoc returns you first have to activate which Ad hoc return mode you want to use. You can do this under App Store -> 3PL -> Settings -> Ad hoc return mode. The 3 return mode options are:

Always create credit note: Use this if you do not wish to attempt to match Ad hoc returns to Return RMAs in TRAEDE. TRAEDE will just always create a credit note

Create credit note if no Return RMA was matched: Use this if you want to try and match the Ad hoc return to a Return RMA in TRAEDE. If no match is found, TRAEDE will create a credit note

Create dashboard alert if no Return RMA was matched: Use this if you want to try and match the Ad hoc return to a Return RMA in TRAEDE. If no match is found, TRAEDE will create dashboard alert. From the alert a credit note can be issued.

Create ad hoc return

Endpoint: POST /3pl/returns/create-ad-hoc-return

ParameterRequiredDefaultDescription
returnYesObject of return

Return

ParameterData typeRequiredDefaultDescription
shipment_numberstringYesThe shipment number that you are trying to create a return for
linesArray<Return line>YesArray of object lines

Return lines

ParameterData typeRequiredDefaultDescription
skustringYes, if no ean is givenThe SKU of the line
eanstringYes, if no sku is givenThe EAN of the line
quantityintegerYesThe number of pieces that were returned
return_to_inventorybooleanYesShould the pieces be put back into stock?
claim_typestringYesShould either be return or claim. This is used purely for reporting purposes. Pieces will only be returned to stock if return_type: return AND return_to_inventory: true
claim_cause_codestringCode of the claim cause
should_refund_shopifybooleantrueShould the return line be refunded in Shopify?

Example

POST /3pl/returns/create-ad-hoc-return

{
"return": {
"shipment_number": "1000-1",
"lines": [
{
"sku": "1000-Black-S",
"quantity": 1,
"claim_type": "return",
"return_to_inventory": true,
"claim_cause_code": "too-small"
},
{
"sku": "1000-Black-S",
"quantity": 1,
"claim_type": "claim",
"return_to_inventory": false,
"claim_cause_code": "damaged"
}
]
}
}