Skip to Main Content
Riverty Docs
  • Get Started
  • Login
riverty logo Docs

Update Order

Use the Update Order endpoint to change the contents of an existing order that is Authorized but not Fully Captured. This endpoint allows you to add or remove items from an existing order without generating a new orderNumber.

Important behavior:

  • You must provide the full order payload in the same structure as used in the original Authorize request, including:
    -- All items in the updated order (not just the changes).
    -- Consistent formatting with the original request.
  • If you add new items, be sure to include previously authorized items as well.
  • If you remove items, the request must include the new, complete list of items that should remain in the order.

Risk Assessment:

  • If the TotalGrossAmount increases compared to the original Authorize call, a new Risk Check will be triggered only for the additional amount.
  • If this additional Risk Check is rejected, the original authorization remains valid, and the update is not applied.

Limitations:

  • You cannot update an order that has been Fully Captured.
  • You can update an order that has been Partially Captured — the remaining uncaptured portion is still modifiable.

Path

POST /api/v3/orders/{orderNumber}/updateOrder

Request Parameters

orderNumber
required
string
Order number

Request Body

application/json

required
object
Order details
yourReference
string
Max length: 20
Can be used by purchasing company if they would like to provide internal reference
ourReference
string
Can be used by selling company if they would like to provide specific reference for purchasing company. This field is limited to 128 characters, longer values will be truncated to fit within the specified limit.
object

Responses

  • 401 Authorization has been denied for this request.
  • 413 Request body too large.
  • 429 Too many requests.
  • 500 Internal server error.
Successful Request, +1 JacketUnsuccessful Request, Item Totals Not Updated

Request Example

    
        {
 "updateOrderSummary": {
  "items": [
   {
    "imageUrl": "https://developer-sandbox.riverty.com/images/black_leather_jacket.jpg",
    "quantity": 2,
    "productId": "4534-BLK-M",
    "vatAmount": 16,
    "vatPercent": 19,
    "description": "Leather jacket, Black, size M",
    "netUnitPrice": 84,
    "grossUnitPrice": 100
   },
   {
    "imageUrl": "https://developer-sandbox.riverty.com/images/grey_socks.jpg",
    "quantity": 5,
    "productId": "5745-GRY-M",
    "vatAmount": 1.6,
    "vatPercent": 19,
    "description": "Socks, Grey, Size M",
    "netUnitPrice": 8.4,
    "grossUnitPrice": 10
   },
   {
    "imageUrl": "https://developer-sandbox.riverty.com/images/brown_wool_hat.jpg",
    "quantity": 1,
    "productId": "3323-BRN-M",
    "vatAmount": 4.79,
    "vatPercent": 19,
    "description": "Woolen hat, brown, Size M",
    "netUnitPrice": 25.21,
    "grossUnitPrice": 30
   },
   {
    "type": "ShippingFee",
    "quantity": 1,
    "productId": "SHIP",
    "vatAmount": 0.8,
    "vatPercent": 19,
    "description": "Shipping",
    "netUnitPrice": 4.2,
    "grossUnitPrice": 5
   }
  ],
  "currency": "EUR",
  "totalNetAmount": 239.41,
  "totalGrossAmount": 285
 }
}
    

Response Example

    
        {
 "outcome": "Accepted",
 "checkoutId": "e0dd7344-fa0a-4a15-9004-6969fc411957",
 "reservationId": "f76c54b6-7183-4d19-8d2b-292ed93ca96d",
 "expirationDate": "2023-10-28"
}