Update Order

Change the contents of an Authorized but not Captured order. Use this call to add or remove items in an existing Order, without creating a new orderNumber. You must provide the entire body of the query, in the same format as Authorize, including all Order Items. (If you added an item, Update Order must contain previously Authorized items as well. If you removed an item, Update Order must contain the new full list of Order Items.) If the TotalGrossAmount has increased compared to the Authorize call for this orderNumber, a new Risk Check will be made for the additional amount. If the additional Risk Check returns a rejection, the original Authorize will remain valid.

Path

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

Request Parameters

orderNumber

required

string

Order number

Request Body

application/json

updateOrderSummary

required

object

Order details

totalNetAmount

required

number

Total net amount of order.

totalGrossAmount

required

number

Total gross amount of order. Must match the grossUnitPrice * quantity of order items

currency

string

Currency

risk

object

channelType

string

Order channel type

deliveryType

string

Order delivery type

ticketDeliveryMethod

string

airline

object

passengers

array

Passengers

itineraries

array

Itineraries

insurance

object

bookingReference

string

Booking reference

bus

object

passengers

array

Passengers

itineraries

array

Itineraries

insurance

object

bookingReference

string

Booking reference

train

object

passengers

array

Passengers

itineraries

array

Itineraries

insurance

object

bookingReference

string

Booking reference

ferry

object

passengers

array

Passengers

itineraries

array

Itineraries

insurance

object

bookingReference

string

Booking reference

rental

object

company

string

Name of rental company

pickupLocation

object

Base class of Address fields

dropoffLocation

object

Base class of Address fields

startDate

string

Pick up date and time

endDate

string

End date and time

drivers

array

Information about drivers who have rented a car

identificationNumber

string

National ID number (if the customer is a physical person). Registration number (if the customer is a company).

address

object

Customer address

legalForm

string

Type of business. Required for Austria, Germany and Switzerland.

riskData

object

existingCustomer

boolean

Is customer an existing customer for merchant

verifiedCustomerIdentification

boolean

Is identification verified

marketingOptIn

boolean

Shows if merchant is allowed to send marketing information to customer

customerSince

string

Since when customer has been merchant's client

customerClassification

string

Customer reputation (e.g. VIP client)

acquisitionChannel

string

Customer acquisition channel

hasCustomerCard

boolean

Shows if customer has loyalty card

customerCardSince

string

The date when the loyalty card was issued to the customer

customerCardClassification

string

Specifies the level of the loyalty card (e.g Gold member). For DE, AT, CH, this must be an integer from 1 to 5, where 5 is the highest VIP level.

profileTrackingId

string

Unique Id of the device for profile tracking

ipAddress

string

Customer’s IP address

numberOfTransactions

integer

Total number of successful purchases that have been made by the specific consumer

customerIndividualScore

string

The customer's individual risk score provided by the merchant. Accepts a number from -10000 to 10000 (can be encased in quotation marks or not), or a single case-insensitive letter from 'a' to 'z'.

userAgent

string

UserAgent of this specific consumer

amountOfTransactions

number

Amount of paid orders last 12 months

otherPaymentMethods

boolean

Other payment method than MI in wallet

customerNumber

string

Customer number has to be unique, if no customer number available please leave empty

salutation

string

Salutation

firstName

string

First name. Everything over 50 characters will be truncated

lastName

string

Last name. Everything over 255 characters will be truncated

companyName

string

Purchasing company name. Everything over 255 characters will be truncated. This field is mandatory for processing B2B transactions in Austria, Belgium, Germany, the Netherlands and Switzerland.

string

phone

string

Phone

mobilePhone

string

Mobile phone

birthDate

required

string

Date of birth. Not required if customerCategory is 'Company'.

customerCategory

required

string

Customer category

conversationLanguage

string

Language code

distributionType

string

How information (invoices, notices, etc.) will be distributed to customer.

vatId

string

VAT registration number, the unique number that identifies a business. This field is mandatory for processing B2B transactions in Austria, Germany and Switzerland.

price

number

Price of a rental car

currency

string

Currency

bookingReference

string

Booking reference

hotel

object

company

string

address

object

Base class of Address fields

checkin

string

Check-in date and time

checkout

string

Check-out date and time

guests

array

Guests information

identificationNumber

string

National ID number (if the customer is a physical person). Registration number (if the customer is a company).

address

object

Customer address

legalForm

string

Type of business. Required for Austria, Germany and Switzerland.

riskData

object

existingCustomer

boolean

Is customer an existing customer for merchant

verifiedCustomerIdentification

boolean

Is identification verified

marketingOptIn

boolean

Shows if merchant is allowed to send marketing information to customer

customerSince

string

Since when customer has been merchant's client

customerClassification

string

Customer reputation (e.g. VIP client)

acquisitionChannel

string

Customer acquisition channel

hasCustomerCard

boolean

Shows if customer has loyalty card

customerCardSince

string

The date when the loyalty card was issued to the customer

customerCardClassification

string

Specifies the level of the loyalty card (e.g Gold member). For DE, AT, CH, this must be an integer from 1 to 5, where 5 is the highest VIP level.

profileTrackingId

string

Unique Id of the device for profile tracking

ipAddress

string

Customer’s IP address

numberOfTransactions

integer

Total number of successful purchases that have been made by the specific consumer

customerIndividualScore

string

The customer's individual risk score provided by the merchant. Accepts a number from -10000 to 10000 (can be encased in quotation marks or not), or a single case-insensitive letter from 'a' to 'z'.

userAgent

string

UserAgent of this specific consumer

amountOfTransactions

number

Amount of paid orders last 12 months

otherPaymentMethods

boolean

Other payment method than MI in wallet

customerNumber

string

Customer number has to be unique, if no customer number available please leave empty

salutation

string

Salutation

firstName

string

First name. Everything over 50 characters will be truncated

lastName

string

Last name. Everything over 255 characters will be truncated

companyName

string

Purchasing company name. Everything over 255 characters will be truncated. This field is mandatory for processing B2B transactions in Austria, Belgium, Germany, the Netherlands and Switzerland.

string

phone

string

Phone

mobilePhone

string

Mobile phone

birthDate

required

string

Date of birth. Not required if customerCategory is 'Company'.

customerCategory

required

string

Customer category

conversationLanguage

string

Language code

distributionType

string

How information (invoices, notices, etc.) will be distributed to customer.

vatId

string

VAT registration number, the unique number that identifies a business. This field is mandatory for processing B2B transactions in Austria, Germany and Switzerland.

numberOfRooms

integer

Number of rooms

price

number

Price of the hotel accommodation

currency

string

Currency

bookingReference

string

Booking reference

merchantImageUrl

string

Image URL for the merchants brand. This image is shown at the top of the order page in Riverty. Supported image formats are: gif, jpeg (jpg), png, webp.

imageUrl

string

URL for the image of this product. It will be turned into a thumbnail and displayed in Riverty, on the invoice line next to the order item. The linked image must be a rectangle or square, width between 100 pixels and 1280 pixels. Supported image formats are: gif, jpeg (jpg), png, webp.

googleAnalyticsUserId

string

User ID identifies a user that may interact with content using different browser instances and devices

googleAnalyticsClientId

string

Client ID is the identifier used by Google Analytics to represent a browser instance or device

items

array

Array of order items. Maximum allowed 200 items.

productId

required

string

Merchant Product identification number.

groupId

string

Item group ID. The group this item belongs to. Provided by the merchant. Everything over 50 characters will be truncated.

description

required

string

Product name. For example "Black music player 64GB". Everything over 255 characters will be truncated.

type

string

netUnitPrice

required

number

Net unit price.

grossUnitPrice

required

number

Gross price per item.

quantity

required

number

Quantity. Use of integer is strongly proposed. If you want to use decimal, please contact your integration manager.

unitCode

string

Unit code (for example pieces, liters, kilograms, etc.).

vatCategory

string

Vat category

vatPercent

required

number

Tax percent.

vatAmount

required

number

Tax amount per item.

imageUrl

string

googleProductCategoryId

integer

Google product category ID.

googleProductCategory

string

Indicates the category of the item based on the Google product taxonomy. Categorizing the product helps ensure that the ad is shown with the right search results.

merchantProductType

string

Categorization used by Merchant as a complement to Google Taxonomy.

lineNumber

integer

Line number. The merchant may add a line number to each order item, to sort them in a particular order.

productUrl

string

URL to the product.

marketPlaceSellerId

string

ID of an individual seller on a marketplace.

parentTransactionReference

string

A unique reference provided to Riverty by a third party (merchant or Payment Service Provider). Identifies an entire order.

additionalInformation

string

Extended description of the order item.

specification

N/A

Specification.

serviceStart

string

Capture start time.

serviceEnd

string

Capture end time.

productUser

string

Product User

costCenter

string

Used for B2B to specify the costCenter e.g. Marketing or Sales Department - Displayed on the invoice.

yourReference

string

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 20 characters, longer values will be truncated to fit within the specified limit.

Responses

Successful Request, +1 Jacket

Unsuccessful Request, Item Totals Not Updated

Response Example

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

Request Example

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

Response Example

    
        [
 {
  "type": "BusinessError",
  "code": "400.101",
  "message": "TotalNetAmount doesn't match with items prices.",
  "customerFacingMessage": "TotalNetAmount komt niet overeen met de itemprijzen.",
  "actionCode": "Unavailable",
  "fieldReference": "updateOrderSummary.totalNetAmount"
 },
 {
  "type": "BusinessError",
  "code": "400.102",
  "message": "Order gross amount doesn't match with items prices.",
  "customerFacingMessage": "Order gross amount doesn't match with items prices.",
  "actionCode": "Unavailable",
  "fieldReference": "updateOrderSummary.totalGrossAmount"
 }
]

Request Example

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