OrderStatus - PUT

Change the status of an order item.

api/{role}/OrderStatus/{id}
?ItemNumber={ItemNumber}
&Status={Status}

Request Information

Property	Note	Constraints
id : string	Order Number URL encode reserved characters	Required
ItemNumber : string	Order Item Index	Required Max length: 50
Status : OrderRequestState	Status to change order item to.	Required
role : string

Response Information

GenericPutResponse

Property	Note	Constraints
OrderNumber : string
ItemNumber : string
Error : string
Success : boolean
Message : string
ResponseID : integer
Status : PushStatus

Response Formats

application/json, text/json

{
  "orderNumber": "test 1",
  "itemNumber": "test 2",
  "error": "test 3",
  "success": true,
  "message": "test 3",
  "responseID": 4,
  "status": 1
}

application/xml, text/xml

<GenericPutResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FOTS.DTO">
  <ResponseID>4</ResponseID>
  <Error>test 3</Error>
  <ItemNumber>test 2</ItemNumber>
  <OrderNumber>test 1</OrderNumber>
</GenericPutResponse>

Back To API Explorer