PUT v1/Shipments/{shipmentId}/AddParameter
Add a parameter to the OrderShipment. If the key already exists, value if overritten, otherwise key is created.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| shipmentId | integer |
Required. |
Body Parameters
OrderShipmentParam| Name | Description | Type | Additional information |
|---|---|---|---|
| Key |
Gets or sets the key. |
string |
Required |
| Value |
Gets or sets the value. |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Key": "sample string 1",
"Value": "sample string 2"
}
application/xml, text/xml
Sample:
<OrderShipmentParam 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> </OrderShipmentParam>
Response Information
Resource Description
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. |