PUT v2/CovaOrder({orderId})
NOTE: This call is not compatible for Tax Inclusive locations. Please use TIP/TEP endpoints. 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:
Base URL:
https://api.covasoft.net/covaorderintake
Example of a call would be:
https://api.covasoft.net/covaorderintake/v2/CovaOrder(2a8f5d33-eec9-4864-8b49-5636577b40d5) Note the v2
in this URI
Note:
This PUT
call will create an order. 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/v2/CovaOrder({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}",
"Items": [ ... ]
}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
orderId | string |
None. |
Body Parameters
Details needed for the Cova Sales Order
CovaSalesOrderPutName | Description | Type | Additional information |
---|---|---|---|
IntegratorId |
Identifier given to an integrator |
globally unique identifier |
None. |
CompanyId | integer |
None. |
|
EntityId | integer |
None. |
|
FirstName | string |
None. |
|
LastName | string |
None. |
|
customerId | globally unique identifier |
None. |
|
IsDelivery | boolean |
None. |
|
ExternalOrderId |
Order identifier from the submitting partner. Used as a cross-reference |
string |
None. |
Items | Collection of CovaOrderItems |
None. |
|
Discount |
Discounts are optional and at Invoice Level |
Discount |
None. |
Taxes |
This Section is optional - Note: Sending Tax amounts is optional but if you do it will overide what is in Cova and you are responsible for provided the correct Tax amounts |
Collection of Tax |
None. |
Request Formats
application/json, text/json
{ "IntegratorId": "4a66d606-c148-45f2-ac07-5f78dbed83bc", "CompanyId": 2, "EntityId": 3, "FirstName": "sample string 4", "LastName": "sample string 5", "customerId": "4357c820-e8c4-4313-a46a-2981b01154b6", "IsDelivery": true, "ExternalOrderId": "sample string 8", "Items": [ { "name": "sample string 1", "catalogItemId": "71f490ec-ba5b-4029-8563-29f24922a915", "quantity": 3.1, "sellAtPricePerUnit": 4.1, "packageId": "sample string 5" }, { "name": "sample string 1", "catalogItemId": "71f490ec-ba5b-4029-8563-29f24922a915", "quantity": 3.1, "sellAtPricePerUnit": 4.1, "packageId": "sample string 5" } ], "Discount": { "invoiceLevel": [ { "name": "sample string 1", "value": 2.1, "valueType": "sample string 3" }, { "name": "sample string 1", "value": 2.1, "valueType": "sample string 3" } ], "Granted": true, "Tag": "sample string 2", "Percentage": 1.1, "Dollar": 1.1 }, "Taxes": [ { "taxId": "2adc8f4e-0742-4fb8-8e04-c9c6099e34cb", "taxAmount": 2.1 }, { "taxId": "2adc8f4e-0742-4fb8-8e04-c9c6099e34cb", "taxAmount": 2.1 } ] }
Response Information
Resource Description
Returns the Sales Order Created at the Location specified within the Company
CovaSalesOrderPutReturnName | Description | Type | Additional information |
---|---|---|---|
OrderSource |
Integrator information |
OrderSource |
None. |
IntegratorId |
Identifier given to an integrator |
globally unique identifier |
None. |
id | globally unique identifier |
None. |
|
companyId | integer |
None. |
|
entityId | integer |
None. |
|
firstName | string |
None. |
|
lastName | string |
None. |
|
customerId | globally unique identifier |
None. |
|
dateCreatedUtc | date |
None. |
|
items | Collection of CovaOrderItems |
None. |
|
discount |
Discounts are optional and at Invoice Level |
Discount |
None. |
isDelivery | boolean |
None. |
|
receiptNumber | string |
None. |
|
taxes | Collection of Tax |
None. |
Response Formats
application/json, text/json
{ "OrderSource": { "id": "8940ff15-aac4-447c-8ead-45efb8dc5fbf", "name": "sample string 2" }, "IntegratorId": "13a2eeec-abe8-4f55-918f-7388234b31a1", "id": "0e38a607-c964-436c-9c96-e6312a059e7f", "companyId": 3, "entityId": 4, "firstName": "sample string 5", "lastName": "sample string 6", "customerId": "3c19e241-4816-41c2-bfbc-b154c95669e9", "dateCreatedUtc": "2024-11-07T08:49:56.5958238+00:00", "items": [ { "name": "sample string 1", "catalogItemId": "a6eb0f73-266f-49d6-af85-f647b1a785e2", "quantity": 3.1, "sellAtPricePerUnit": 4.1, "packageId": "sample string 5" }, { "name": "sample string 1", "catalogItemId": "a6eb0f73-266f-49d6-af85-f647b1a785e2", "quantity": 3.1, "sellAtPricePerUnit": 4.1, "packageId": "sample string 5" } ], "discount": { "invoiceLevel": [ { "name": "sample string 1", "value": 2.1, "valueType": "sample string 3" }, { "name": "sample string 1", "value": 2.1, "valueType": "sample string 3" } ], "Granted": true, "Tag": "sample string 2", "Percentage": 1.1, "Dollar": 1.1 }, "isDelivery": true, "receiptNumber": "sample string 10", "taxes": [ { "taxId": "2c7bbe3b-b6e8-4341-8551-1daf4d9e36ea", "taxAmount": 2.1 }, { "taxId": "2c7bbe3b-b6e8-4341-8551-1daf4d9e36ea", "taxAmount": 2.1 } ] }