GET v1/companies/{CompanyId}/entities/{LocationId}/integrators/{IntegratorId}/Orders/{OrderId}?EntityId={EntityId}

Get order details by order Id

Information:

Base URL:

https://api.covasoft.net/covaorderintake

Example of a call would be:

https://api.covasoft.net/covaorderintake/v1/companies/{CompanyId}/entities/{LocationId}/integrators/{IntegratorId}/Orders/{OrderId}

Usage:

Use this endpoint to get the order details of an order for a specific integrator.

NOTE CURRENTLY IntegratorId PARAMETER IS IGNORED, AND ALL ORDERS RETURNED. BE ADVISED THAT THIS WILL CHANGE AT A FUTURE DATE

Request Information

URI Parameters

Name	Description	Type	Additional information
CompanyId	The company the order was created at.	integer	Required
EntityId	The location the order was created at.	integer	Required
IntegratorId	The integrator who created the order.	globally unique identifier	Required
OrderId	The Id of the order.	globally unique identifier	Required
LocationId		string	None.

Body Parameters

None.

Response Information

Resource Description

CovaSalesOrderGetOrderDetailsByIdReturn

Name	Type	Additional information
OrderId	globally unique identifier	None.
OrderNumber	string	None.
InvoiceId	globally unique identifier	None.
Status	string	None.
LocationId	integer	None.
InvoiceNumber	string	None.
CustomerId	globally unique identifier	None.
Products	Collection of CovaSalesOrderGetOrderDetailsByIdProduct	None.
Payments	Collection of CovaSalesOrderGetOrderDetailsByIdPayment	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderId": "3a0380c2-2c9b-447e-a59d-abe97632c150",
  "OrderNumber": "sample string 2",
  "InvoiceId": "232462ba-1f40-4bbb-a1ae-78729e049a95",
  "Status": "sample string 4",
  "LocationId": 5,
  "InvoiceNumber": "sample string 6",
  "CustomerId": "8eff8021-a39d-4b2b-9da6-cea2eb38c200",
  "Products": [
    {
      "ProductId": "1c139a3b-2d59-4aa9-8d14-6838a37a8b3b",
      "Quantity": 2.0,
      "AmountBeforeTax": 3.0,
      "Taxes": {
        "Tax": 1.0,
        "TaxDetails": [
          {
            "TaxId": "sample string 1",
            "Tax": 2.0,
            "TaxName": "sample string 3"
          },
          {
            "TaxId": "sample string 1",
            "Tax": 2.0,
            "TaxName": "sample string 3"
          }
        ]
      }
    },
    {
      "ProductId": "1c139a3b-2d59-4aa9-8d14-6838a37a8b3b",
      "Quantity": 2.0,
      "AmountBeforeTax": 3.0,
      "Taxes": {
        "Tax": 1.0,
        "TaxDetails": [
          {
            "TaxId": "sample string 1",
            "Tax": 2.0,
            "TaxName": "sample string 3"
          },
          {
            "TaxId": "sample string 1",
            "Tax": 2.0,
            "TaxName": "sample string 3"
          }
        ]
      }
    }
  ],
  "Payments": [
    {
      "Last4Digits": "sample string 1",
      "CustomerAccountId": "sample string 2",
      "PaymentMethodId": 3,
      "PaymentMethodName": "sample string 4",
      "Amount": 5.1,
      "TransactionDateUtc": "2025-12-08T06:27:23.4531579+00:00"
    },
    {
      "Last4Digits": "sample string 1",
      "CustomerAccountId": "sample string 2",
      "PaymentMethodId": 3,
      "PaymentMethodName": "sample string 4",
      "Amount": 5.1,
      "TransactionDateUtc": "2025-12-08T06:27:23.4531579+00:00"
    }
  ]
}