PUT v1/TEPCovaOrder({orderId})
This call creates a Sales Order for a location with Tax Exclusive Pricing. This call creates a Sales Order at the Location specified within the Company and requires an Integrator Id. The integrator Id will identify the source of the order within Cova. This is needed to distinguish order sources when multiple integrators are creating orders.
Information:
The intent is to represent orders with taxes included or excluded in the prices of each line item, depending on the explicit endpoint being called. Tax Inclusive Pricing is TIP
and the historical Tax Exclusive Pricing is TEP
.Separate explicit calls to create orders based on the two tax pricing schemes is a way to ensure understanding of the key differences
Additional Documentation
Determine Tax Pricing Configuration
Base URL:
https://api.covasoft.net/covaorderintake
Example of a call would be:
https://api.covasoft.net/covaorderintake/v1/TEPCovaOrder(2a8f5d33-eec9-4864-8b49-5636577b40d5)
Note:
This PUT
call will create an order. Use this call if Tax Pricing Configuration for the location/entityId is Exclusive
or there is no configuration.
As an integrator, you must generate an OrderId
GUID value.
The generated id must be supplied in the URL AND in the body of the PUT request as the id
value
PUT /covaorderintake/v1/TEPCovaOrder({your generated id})
Host: api.covasoft.net
Authorization: Bearer {your token}
Accept: application/json
Content-Type: application/json
{
"Id":"{your generated id}",
"CompanyId": 1,
"EntityId": 2,
.... etc
"IntegratorId":"{integratorId}",
"Lines": [ ... ]
}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
orderId | string |
None. |
Body Parameters
Details needed for the Cova Sales Order
CovaSalesOrderWithLinesName | Description | Type | Additional information |
---|---|---|---|
Id | string |
None. |
|
CompanyId | integer |
None. |
|
EntityId | integer |
None. |
|
OrderReference |
Displayed in Cova POS if a valid `CustomerId` is not supplied. Recommend [$firstName $lastName] |
string |
None. |
CustomerId | string |
None. |
|
IntegratorId | string |
None. |
|
IsDelivery | boolean |
None. |
|
ExternalOrderId |
Order identifier from the submitting partner. Used as a cross-reference |
string |
None. |
Lines |
Replaces `Items` in legacy orders |
Collection of OrderLine |
None. |
Request Formats
application/json, text/json
{ "Id": "sample string 1", "CompanyId": 2, "EntityId": 3, "OrderReference": "sample string 4", "CustomerId": "sample string 5", "IntegratorId": "sample string 6", "IsDelivery": true, "ExternalOrderId": "sample string 8", "Lines": [ { "Name": "sample string 1", "CatalogItemId": "sample string 2", "Quantity": 3.1, "LineDollarAmount": 4.1, "PackageId": "sample string 5" }, { "Name": "sample string 1", "CatalogItemId": "sample string 2", "Quantity": 3.1, "LineDollarAmount": 4.1, "PackageId": "sample string 5" } ] }
Response Information
Resource Description
Returns and empty body with an HTTP Accepted - 202 status
HttpStatusCodeResponse Formats
application/json, text/json
100