GET api/SetStatus?OrderNumber={OrderNumber}&OriginApplication={OriginApplication}&SourceApplication={SourceApplication}&Status={Status}&StatusDate={StatusDate}&SendCommunication={SendCommunication}

Updates an order's status There is a potential problem with this method if OrderNumber is duplicated, which does occur for 2nd pair orders that have been cancelled and then later reordered in CalicoCloud.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OrderNumber

string

Required
OriginApplication

string

Required
SourceApplication

string

Required
Status

string

Required
StatusDate

date

Required
SendCommunication

boolean

Required

Body Parameters

None.

Response Information

Resource Description

ReturnObject
NameDescriptionTypeAdditional information
Success

boolean

None.
Id

integer

None.
Message

string

None.
ExceptionMessage

string

None.
OrderGUID

globally unique identifier

None.
OrderNumber

string

None.
AdditionalData_1

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Id": 2,
  "Message": "sample string 3",
  "ExceptionMessage": "sample string 4",
  "OrderGUID": "3392849c-cd9d-4f27-bf39-ef3e38eb3971",
  "OrderNumber": "sample string 6",
  "AdditionalData_1": "sample string 7"
}

application/xml, text/xml

Sample: 
<ReturnObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Communication.Module.TransferLayer.Models">
  <AdditionalData_1>sample string 7</AdditionalData_1>
  <ExceptionMessage>sample string 4</ExceptionMessage>
  <Id>2</Id>
  <Message>sample string 3</Message>
  <OrderGUID>3392849c-cd9d-4f27-bf39-ef3e38eb3971</OrderGUID>
  <OrderNumber>sample string 6</OrderNumber>
  <Success>true</Success>
</ReturnObject>