PUT v1/Orders/{orderId}/CustomStatus
Update the Custom Order status.
Request Information
Requires Authorization!
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
orderId |
The id of the Order. |
integer |
Required. |
Body Parameters
The new values for the Custom Order status.
OrderStatusChangeForOrderName | Description | Type | Additional information |
---|---|---|---|
OrderStatusId |
The Order Status Id |
integer |
None. |
ActionDate |
Gets or sets the action date. |
date |
None. |
Comment |
Gets or sets the comment. |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "OrderStatusId": 1, "ActionDate": "2021-12-02T20:19:34.1072333+01:00", "Comment": "sample string 2" }
application/xml, text/xml
Sample:
<OrderStatusChangeForOrder xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <OrderStatusId>1</OrderStatusId> <ActionDate>2021-12-02T20:19:34.1072333+01:00</ActionDate> <Comment>sample string 2</Comment> </OrderStatusChangeForOrder>
Response Information
Response Codes
- OK (200)
- NotFound (404)
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. |