GET v1/Companies({CompanyId})/CovaOrder({SalesOrderId})/Status
NOTE: This call should no longer be used. Move to v2 Status endpoint.
Information:
Base URL:
https://api.covasoft.net/covaorderintake
Example of a call would be:
https://api.covasoft.net/covaorderintake/v1/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
- PaymentSubmittedForProcessing
- PaymentApplied
- 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
CovaSalesOrderStatusReturnName | 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 |
OrderStatus |
None. |
Message |
Returned with non transient errors to describe why the order cannot be created. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "CompanyId": 1, "OrderId": "1d334a36-5b5e-4160-9aaf-b231437f3f7f", "OrderStatus": 0, "Message": "sample string 3" }