riverty logo

Docs

Return Order

Path

POST /businesses/{businessCode}/customers/{customerNumber}/orders/{orderReference}/returns

Request Parameters

businessCode
required
string
The business in the context of which this request is to be executed, e.g. 1000
customerNumber
required
string
The customer in the context of which this request is to be executed, e.g. TFI2021072801
orderReference
required
string
The order in the context of which this request is to be executed, e.g. TFI2021072801_03
X-Request-ID
string
The unique ID of this particular request/transaction. Subsequent requests with the same request ID might get ignored.

Request Body

application/json

object
invoiceReference
string
Max length: 30
maxLength(30)
Invoice number of referenced invoice
required
array
Values(>=1)
The individual items of the original order to be returned; if omitted, the entire order will be returned
returnDate
required
string
yyyy-MM-dd
Format(yyyy-MM-dd)
Date the return has been received
returnReason
required
string
Enum:

CARRIER_RETURN

CUSTOMER_RETURN

Reason for the return: * CARRIER_RETURN = carrier return * CUSTOMER_RETURN = customer return
returnReference
required
string
Max length: 30
maxLength(30)
External return reference (defined by order management system)

Responses

Request Example

    
        {
 "items": [
  {
   "vatType": "NORMAL",
   "quantity": 2.5,
   "vatAmount": 19.02,
   "vatPercent": 19,
   "grossUnitPrice": 119.12,
   "orderItemReference": 3
  }
 ],
 "returnDate": "2018-09-11",
 "bankDetails": {
  "bic": "GENODEM1MSC",
  "iban": "DE51100100501234567890",
  "accountOwner": "Max Mustermann"
 },
 "returnReason": "CUSTOMER_RETURN",
 "returnReference": "RDE12345678901",
 "invoiceReference": "IDE12345678901"
}

Response Example

    
        {
 "internalRequestId": "23c9579b-baaf-468f-a529-f876226e183c"
}