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

NameDescriptionTypeAdditional information
CompanyId

integer

Required
SalesOrderId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Returns the company, order id, and status

CovaSalesOrderStatusReturn
NameDescriptionTypeAdditional 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": "37d07657-205e-4216-a5d8-565e4dae965c",
  "OrderStatus": 0,
  "Message": "sample string 3"
}