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

CovaSalesOrderPut

Name	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

Sample:

{
  "IntegratorId": "b6f78cb5-760c-46f4-8a01-b087dc305b24",
  "CompanyId": 2,
  "EntityId": 3,
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "customerId": "cfbd9fec-398c-44ca-9a9b-7f25a31c7e49",
  "IsDelivery": true,
  "ExternalOrderId": "sample string 8",
  "Items": [
    {
      "name": "sample string 1",
      "catalogItemId": "a482d06e-9794-49db-bb1d-0d60195e3eb0",
      "quantity": 3.1,
      "sellAtPricePerUnit": 4.1,
      "packageId": "sample string 5"
    },
    {
      "name": "sample string 1",
      "catalogItemId": "a482d06e-9794-49db-bb1d-0d60195e3eb0",
      "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": "0c77786f-cb48-4424-9b22-62741c0db281",
      "taxAmount": 2.1
    },
    {
      "taxId": "0c77786f-cb48-4424-9b22-62741c0db281",
      "taxAmount": 2.1
    }
  ]
}

Response Information

Resource Description

Returns the Sales Order Created at the Location specified within the Company

CovaSalesOrderPutReturn

Name	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

Sample:

{
  "OrderSource": {
    "id": "a863ca4c-f2c6-4974-b28f-5cab1e5b712e",
    "name": "sample string 2"
  },
  "IntegratorId": "76a60b19-65b3-4ea0-945c-d1949bd80e27",
  "id": "34018c4f-6e75-41e0-8a8d-a0d44aa251e3",
  "companyId": 3,
  "entityId": 4,
  "firstName": "sample string 5",
  "lastName": "sample string 6",
  "customerId": "d8611131-b10c-4e14-8c2c-8420ac956777",
  "dateCreatedUtc": "2024-11-25T11:29:39.4892371+00:00",
  "items": [
    {
      "name": "sample string 1",
      "catalogItemId": "db1fb430-871f-451b-921a-0eeca7446bf3",
      "quantity": 3.1,
      "sellAtPricePerUnit": 4.1,
      "packageId": "sample string 5"
    },
    {
      "name": "sample string 1",
      "catalogItemId": "db1fb430-871f-451b-921a-0eeca7446bf3",
      "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": "a9685910-f541-4f43-8a78-9da60146f2de",
      "taxAmount": 2.1
    },
    {
      "taxId": "a9685910-f541-4f43-8a78-9da60146f2de",
      "taxAmount": 2.1
    }
  ]
}