GET v1/Orders/{orderId}/Parameters/{key}

Get a single Order Parameter.

Request Information

Requires Authorization!

URI Parameters

NameDescriptionTypeAdditional information
orderId

The id of the order.

 integer

Required.
key

The order parameter key.

 string

Required.

Body Parameters

None.

Response Information

Response Codes

  • OK (200)
  • NotFound (404)

Resource Description

An 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.

Response 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>