POST v1/Orders/{orderId}/Parameters

Add an Order Parameter.

Request Information

Requires Authorization!

URI Parameters

NameDescriptionTypeAdditional information
orderId

The id of the order.

integer

Required.

Body Parameters

The Order Parameter.

Parameter
NameDescriptionTypeAdditional information
Key

Gets or sets the key.

string

None.

Value

Gets or sets the value.

string

None.

DataType

Specify the data type. Default type is String.

KeyValueParameterDataType

None.

Request Formats

application/json, text/json

Sample:
{
  "Key": "sample string 1",
  "Value": "sample string 2",
  "DataType": 0
}

application/xml, text/xml

Sample:
<Parameter xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Key>sample string 1</Key>
  <Value>sample string 2</Value>
  <DataType>String</DataType>
</Parameter>

Response Information

Response Codes

  • OK (200)
  • MultipleChoices (300)

Resource Description

The HttpResponseMessage object.


HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.