UpdateOrderInformation
Updates information of a collection of Orders. This call is intended to handle changes in address information of the Order. The update of additional information on Order level is possible on a later stage but not intended for now.
Request Example
{
"Request": {
"Orders": [
{
"id_sales_order": 123,
"address_billing": {
"first_name":"John",
"last_name": "Doe",
"phone": "1234567",
"phone2": "1234",
"address1": "Sesamestreet 123",
"city": "Berlin",
"postcode": "12345",
"country": "Germany"
}
}
]
}
}
Order Data Structure
Name |
Type |
Mandatory |
Description |
Example |
---|---|---|---|---|
idsalesorder |
integer |
Yes |
Used to identify the order which is being modified, corresponds to OMS order ID. |
389292777 |
address_billing |
array (Address) |
No |
The billing information which is being updated. |
See further table. |
address_shipping |
array (Address) |
No |
The shipping information which is being updated. |
See further table. |
Address array data structure
Documentation changed (16 March 2016)
Please be advised that the documentation was changed in this part. The former mandatory address fields are changed to optional.
In case address data should be updated partly only affected fields need to be send.
Name |
Type |
Mandatory |
---|---|---|
first_name |
string |
No |
last_name |
string |
No |
phone |
string |
No |
phone2 |
string |
No |
address1 |
string |
No |
address2 |
string |
No |
address3 |
string |
No |
address4 |
string |
No |
address5 |
string |
No |
city |
string |
No |
postcode |
string |
No |
country |
string |
No |
Responses
SellerCenter will process all the items independently, making possible that either all the items are successfully updated / some are failed / the whole call fails with no item updated.
Success Response
{
"SuccessResponse": {
"Head": {
"RequestId": "",
"RequestAction": "UpdateOrderInformation",
"ResponseType": "",
"Timestamp": "2015-07-02T12:26:03+0200"
},
"Body": []
}
Error response some failed Items
Only the failed items are listed inside the Items element, along with an error message and code for each one. The position of the item inside the request collection of items is marked with "Position".
{
"ErrorResponse": {
"Head": {
"RequestAction": "UpdateOrderInformation",
"ErrorType": "Sender",
"ErrorCode": "0",
"ErrorMessage": "Some elements were not processed"
},
"Body": {
"UpdateOrderInformation":
[
{
"ErrorCode": null,
"ErrorMessage": "",
"Position": 2
}
]
}
}
In previous example, the failing item is the one sent in “position 2”, so the third item of the request.
Error response
{
"ErrorResponse": {
"Head": {
"RequestAction": "UpdateOrderInformation",
"ErrorType": "Sender",
"ErrorCode": "7",
"ErrorMessage": "E007: Login failed. Signature mismatch"
},
"Body": ""
}
Error Response for items in wrong status
{
"ErrorResponse": {
"Head": {
"RequestAction": "UpdateOrderInformation",
"ErrorType": "Sender",
"ErrorCode": "0",
"ErrorMessage": "Some elements were not processed"
},
"Body": {
"UpdateOrderInformation":
[
{
"ErrorCode": null,
"ErrorMessage": "Address information cannot be changed since order with src_id: XXXXXX is not in pending status",
"Position": 0
}
]
}
}