GET api/SIMS/GetSalesOrderState?Ref={Ref}&companyKey={companyKey}
Get the status of the sales order
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Ref |
Required to check for the sales order |
string |
Required |
| companyKey | string |
Default value is |
Body Parameters
N/A
Response Information
Resource Description
The return type can be the following: If the operation was successful because SO was found in the system and not in the gateway, the ImportSalesStatus class is returned as null, and the other fields (orderRef, State) are filled with the details found in SO. The Status field is marked as "successful" to highlight the state of this operation. A failed operation may be because the "Ref" value is not present, or is stuck in the gateway, or else stuck in the gateway for a specific reason. The ImportSalesStatus class is returned with an error message and an error status along with the other fields (orderRef, State) returned as null, while the Status field is labelled as fail, highlighting the state of this operation.
SalesOrderGatewayStatusResult| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderRef | string |
N/A |
|
| State | string |
N/A |
|
| ErrorStatus | string |
N/A |
|
| GatewayStatus | string |
N/A |
|
| ClientCode | string |
N/A |
|
| ClientName | string |
N/A |
|
| OrderDate | string |
N/A |
|
| ItemsOnSalesOrder | string |
N/A |
|
| ErrorMessage |
The message returned in case of an error. |
string |
N/A |
Response Formats
application/json, text/json
{
"OrderRef": "sample string 1",
"State": "sample string 2",
"ErrorStatus": "sample string 3",
"GatewayStatus": "sample string 4",
"ClientCode": "sample string 5",
"ClientName": "sample string 6",
"OrderDate": "sample string 7",
"ItemsOnSalesOrder": "sample string 8",
"ErrorMessage": "sample string 9"
}