Update order

Order API v1
PUT*base*/orders
Authentication:API key

Update information on the order.

Parameters

order

int
required
Order ID to update.

internalComment

string
optional
Append some text to internal comment field.

replaceInternalComment

boolean
optional
Default false. Replace the full content of the internal comment field with the internalComment.

comment

string
optional
Append some text to comment field.

replaceComment

boolean
optional
Default false. Replace the full content of the comment field with the comment.

extraAttributes

object
optional

Object for sending in custom order attributes

attributeName_elementName

any
List of key-value pairs for every attribute element you want to set. Send it as an empty string to remove the current content.

xml

boolean
optional
Response in xml format instead of json.

Request example

1
2
3
4
5
6
7
PUT <base>/orders HTTP/1.1
Content-type: application/json

{
  "order": 83651,
  "internalComment": "test"
}

Response

200 Content-type: application/json

status

string
required
ok if success, else no.

order

int
Order ID that was updated.

msg

string
optional
If status returns no, this value should send back a message why it failed.

Response example

1
2
3
4
5
6
7
HTTP/1.1 200 OK
Content-type: application/json

{
  "status": "ok",
  "order": 83651
}

Error example

1
2
3
4
5
{
  "status": "no",
  "msg": "order in wrong market",
  "order": 83651
}