UpdateReservation action
UpdateReservation Request
The UpdateReservation action can be used in three scenarios:
- The consumer wants to change the order with a total amount same or lower, update the order lines of the reservation.
- The consumer wants to change the delivery address, update the Klarna shipping address of the reservation.
- The consumer wants to update the order and shipping, all updates can be shared.
In case both the order details and the shipping address are updated, Buckaroo will first request the address change, followed by the order lines change.
Customer UpdateReservation Request
{
"Currency": "EUR",
"Description": "Test KlarnaKP UpdateReservation",
"Services": {
"ServiceList": [
{
"Name": "KlarnaKP",
"Action": "UpdateReservation",
"Parameters": [
{
"Name": "ReservationNumber",
"Value": "d91f5f42-f011-4611-9575-77bb0446d7d2"
},
{
"Name": "ShippingFirstName",
"Value": "Testperson-nl"
},
{
"Name": "ShippingLastName",
"Value": "Approved"
},
{
"Name": "ShippingStreet",
"Value": "Jaherkade 3 D"
},
{
"Name": "ShippingPostalCode",
"Value": "2521VA"
},
{
"Name": "ShippingCity",
"Value": "Gravenhage"
},
{
"Name": "ShippingCountry",
"Value": "NL"
},
{
"Name": "ShippingPhoneNumber",
"Value": "0698765432"
},
{
"Name": "ShippingEmail",
"Value": "[email protected]"
}
]
}
]
}
}
Order UpdateReservation Request
{
"Currency": "EUR",
"Invoice": "Ref.1 OrderID updated",
"ClientIP": {
"Type": 0,
"Address": "0.0.0.0"
},
"Services": {
"ServiceList": [
{
"Name": "klarnakp",
"Action": "UpdateReservation",
"Parameters": [
{
"Name": "ReservationNumber",
"Value": "d91f5f42-f011-4611-9575-77bb0446d7d2"
},
{
"Name": "ArticleTitle",
"GroupType": "Article",
"GroupID": "1",
"Value": "Blue Toy Car"
},
{
"Name": "ArticleNumber",
"GroupType": "Article",
"GroupID": "1",
"Value": "12345"
},
{
"Name": "ArticleType",
"GroupType": "Article",
"GroupID": "1",
"Value": "General"
},
{
"Name": "ArticleQuantity",
"GroupType": "Article",
"GroupID": "1",
"Value": "1"
},
{
"Name": "ArticlePrice",
"GroupType": "Article",
"GroupID": "1",
"Value": "10.00"
},
{
"Name": "ArticleVat",
"GroupType": "Article",
"GroupID": "1",
"Value": "21"
},
{
"Name": "ArticleImageUrl",
"GroupType": "Article",
"GroupID": "1",
"Value": "https://apod.nasa.gov/apod/image/2210/ngc4631_sherick.jpg"
},
{
"Name": "ArticleProductUrl",
"GroupType": "Article",
"GroupID": "1",
"Value": "https://apod.nasa.gov/apod/astropix.html"
}
]
}
]
}
}
Full UpdatedReservation Request
{
"Currency": "EUR",
"Description": "Test KlarnaKP UpdateReservation",
"Services": {
"ServiceList": [
{
"Name": "KlarnaKP",
"Action": "UpdateReservation",
"Parameters": [
{
"Name": "ReservationNumber",
"Value": "d91f5f42-f011-4611-9575-77bb0446d7d2"
},
{
"Name": "ShippingFirstName",
"Value": "Testperson-nl"
},
{
"Name": "ShippingLastName",
"Value": "Approved"
},
{
"Name": "ShippingStreet",
"Value": "Jaherkade 3 D"
},
{
"Name": "ShippingPostalCode",
"Value": "2521VA"
},
{
"Name": "ShippingCity",
"Value": "Gravenhage"
},
{
"Name": "ShippingCountry",
"Value": "NL"
},
{
"Name": "ShippingPhoneNumber",
"Value": "0698765432"
},
{
"Name": "ShippingEmail",
"Value": "[email protected]"
},
{
"Name": "ArticleTitle",
"GroupType": "Article",
"GroupID": "1",
"Value": "Blue Toy Car"
},
{
"Name": "ArticleNumber",
"GroupType": "Article",
"GroupID": "1",
"Value": "12345"
},
{
"Name": "ArticleType",
"GroupType": "Article",
"GroupID": "1",
"Value": "General"
},
{
"Name": "ArticleQuantity",
"GroupType": "Article",
"GroupID": "1",
"Value": "1"
},
{
"Name": "ArticlePrice",
"GroupType": "Article",
"GroupID": "1",
"Value": "10.00"
},
{
"Name": "ArticleVat",
"GroupType": "Article",
"GroupID": "1",
"Value": "21"
},
{
"Name": "ArticleImageUrl",
"GroupType": "Article",
"GroupID": "1",
"Value": "https://apod.nasa.gov/apod/image/2210/ngc4631_sherick.jpg"
},
{
"Name": "ArticleProductUrl",
"GroupType": "Article",
"GroupID": "1",
"Value": "https://apod.nasa.gov/apod/astropix.html"
},
{
"Name": "ArticleTitle",
"GroupType": "Article",
"GroupID": "2",
"Value": "Shipping Fee"
},
{
"Name": "ArticleNumber",
"GroupType": "Article",
"GroupID": "2",
"Value": "123456"
},
{
"Name": "ArticleType",
"GroupType": "Article",
"GroupID": "2",
"Value": "ShipmentFee"
},
{
"Name": "ArticleQuantity",
"GroupType": "Article",
"GroupID": "2",
"Value": "1"
},
{
"Name": "ArticlePrice",
"GroupType": "Article",
"GroupID": "2",
"Value": "4.95"
},
{
"Name": "ArticleVat",
"GroupType": "Article",
"GroupID": "2",
"Value": "21"
},
{
"Name": "ArticleType",
"GroupType": "Article",
"GroupID": "3",
"Value": "Discount"
},
{
"Name": "ArticleTitle",
"GroupType": "Article",
"GroupID": "3",
"Value": "Discount on product"
},
{
"Name": "ArticleNumber",
"GroupType": "Article",
"GroupID": "3",
"Value": "1234567"
},
{
"Name": "ArticleQuantity",
"GroupType": "Article",
"GroupID": "3",
"Value": "1"
},
{
"Name": "ArticlePrice",
"GroupType": "Article",
"GroupID": "3",
"Value": "-2.50"
},
{
"Name": "ArticleVat",
"GroupType": "Article",
"GroupID": "3",
"Value": "0"
}
]
}
]
}
}
Request Parameters
| Parameter | Type | OCM | Description |
|---|---|---|---|
| ArticleTitle | string | M | Name of article |
| ArticleNumber | string | O | Unique product number |
| ArticleType | string | O | Allowed values: physical / digital / shipping_fee / surcharge / discount / gift_card / store_credit |
| ArticlePrice | decimal | M | Price Including VAT |
| ArticleQuantity | integer | M | Number of articles |
| ArticleVat | decimal | O | VAT percentage |
| ArticleImageUrl | string | O | Url of Product image |
| ArticleProductUrl | string | O | Url of PDP |
| ShippingFirstName | string | O | Delivery address first name. |
| ShippingLastName | String | O | Delivery address last name. |
| ShippingStreet | string | O | Delivery address 1st address line |
| ShippingStreet2 | string | O | Delivery address 2nd address line |
| ShippingPostalCode | string | O | Delivery address postal code |
| ShippingCity | string | O | Delivery address city |
| ShippingCountry | string | O | Delivery address country code |
| ShippingEmail | string | O | Delivery address email address |
| ShippingCellPhoneNumber | string | O | Delivery address phone number |
UpdateReservation Response
{
"Key": "354CEDA9094E4699931FAE6DB22485C0",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S990",
"Description": "The request was successful."
},
"DateTime": "2023-03-27T09:30:27"
},
"RequiredAction": null,
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"ServiceCode": "KlarnaKp",
"IsTest": true,
"ConsumerMessage": null
}
Response Parameters
| Parameter | Type | OCM | Description |
|---|---|---|---|
| ServiceCode | string | M | Klarna service label is KlarnaKp |
| Code | string | M | Contains the status of the UpdateReservation not the Reservation |
| IsTest | boolean | M | If there are actual funds processed |
UpdateReservation Push
{
"DataRequest": {
"Key": "13F9A3BBE2B045D9B97FD51BE11A2F23",
"Invoice": null,
"ServiceCode": "KlarnaKp",
"ActionCode": "UpdateReservation",
"Status": {
"Code": {
"Code": 190,
"Description": "The request was successful."
},
"SubCode": null,
"DateTime": "2023-03-27T09:29:37"
},
"IsTest": true,
"Order": null,
"Currency": "EUR",
"AmountDebit": 0,
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 0,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": null
}
}
Push Parameters
| Parameter | Type | OCM | Description |
|---|---|---|---|
| ServiceCode | string | M | Klarna service label is KlarnaKp |
| Code | string | M | Contains the status of the UpdateReservation not the Reservation |
| IsTest | boolean | M | If there are actual funds processed |
Updated 2 months ago