POST v1/Shops/{shopId}/Orders/{orderCode}/{orderRowKey}/Parameters
Add an Order Row Parameter.
Request Information
Requires Authorization!
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
shopId |
The Shop's id |
integer |
Required. |
orderCode |
The Order Code |
string |
Required. |
orderRowKey |
The Order Row Key |
string |
Required. |
Body Parameters
The Order Row Parameter.
OrderRowParameterName | Description | Type | Additional information |
---|---|---|---|
Key |
Gets or sets the key. |
string |
Required Max length: 50 |
Value |
Gets or sets the value. |
string |
Max length: 2147483647 |
DataType |
Specify the data type. Default type is String. |
KeyValueParameterDataType |
Max length: 10 |
Request Formats
application/json, text/json
Sample:
{ "Key": "sample string 1", "Value": "sample string 2", "DataType": 0 }
application/xml, text/xml
Sample:
<OrderRowParameter 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> </OrderRowParameter>
Response Information
Response Codes
- OK (200)
- MultipleChoices (300)
Resource Description
The HttpResponseMessage object.
HttpResponseMessage
Name | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |