Skip to Main Content
Riverty Docs
riverty logo Docs

Cancel Order

An order can be cancelled for any reasons. It can be cancelled either as a complete order if it is not needed by the customer or a position or line item.

More information can be found in our Link

Path

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

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
cancellationDate
required
string
yyyy-MM-dd
Format(yyyy-MM-dd)
Date the cancellation has been saved
cancellationReason
required
string
Enum:
  • OUT_OF_STOCK
  • CUSTOMER_CANCELLATION
  • NO_PAYMENT
  • CUSTOMER_SERVICE
Reason for the cancellation: * OUT_OF_STOCK = Out of stock * CUSTOMER_CANCELLATION = Customer cancellation * NO_PAYMENT = No payment * CUSTOMER_SERVICE = Customer service
invoiceReference
string
Max length: 30
maxLength(30)
Invoice number of referenced invoice
array
The items that are to be cancelled

Responses

Cancellation with bank details if refund needs to be processedCancellation without refund needed

Request Example

    
        {
 "items": [
  {
   "orderItemReference": 3
  }
 ],
 "bankDetails": {
  "bic": "GENODEM1MSC",
  "iban": "DE51100100501234567890",
  "accountOwner": "Max Mustermann"
 },
 "cancellationDate": "2018-03-21",
 "invoiceReference": "IDE12345678901",
 "cancellationReason": "OUT_OF_STOCK"
}

Response Example

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