GET v2/Companies({CompanyId})/CovaOrder({SalesOrderId})/Status
Returns the status of the order and payment (if applicable)
Information:
Base URL:
https://api.covasoft.net/covaorderintake
Example of a call would be:
https://api.covasoft.net/covaorderintake/v2/Companies({companyId})/CovaOrder({salesOrderId})/Status
Order Status:
The following is a list of the possible OrderStatus property values, ordered by typical transition, with the last three being exceptional cases.
- SubmittedForProcessing
- SubmittedForFinalProcessing
- ReadyForPayment
- Completed
- Cancelled
- TransientProcessingFailure => internal Cova failure, please try again
- NonTransientProcessingFailure => similar to "bad request". Cova could not handle the data, please contact API Support.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId | integer |
Required |
|
| SalesOrderId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns the company, order id, and status
CovaSalesOrderStatusReturnV2| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId |
Company identifier |
integer |
None. |
| OrderId |
Order identifier. Also sometimes referred to as SaleId |
globally unique identifier |
None. |
| OrderStatus |
Enumeration of Order Status values |
OrderStatusV2 |
None. |
| OrderMessage |
Returned with non transient errors to describe why the order cannot be created. |
string |
None. |
| PaymentStatus | PaymentStatusV2 |
None. |
|
| PaymentMessage | string |
None. |
|
| SaleTotal | decimal number |
None. |
|
| OrderFulfillmentMethod |
InStore, Delivery, Pickup |
string |
None. |
| OrderFulfillmentStatus |
OrderPlaced, InProgress, ReadyForPickup |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"CompanyId": 1,
"OrderId": "8ac0a4f6-f329-4e5e-8d04-8af0fe3b4506",
"OrderStatus": 0,
"OrderMessage": "sample string 3",
"PaymentStatus": 0,
"PaymentMessage": "sample string 4",
"SaleTotal": 5.0,
"OrderFulfillmentMethod": "sample string 6",
"OrderFulfillmentStatus": "sample string 7"
}