Order API - Update order

Update order

Endpoint: 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 the 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 the 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
optional

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

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
required

Order ID that was updated

msg
string
optional

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

Response example

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

Error example

{
  "status": "no",
  "msg": "order in wrong market",
  "order": 83651
}

Previous article: Order API - Get Orders