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

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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": "f1bc563f-2eac-4459-a742-361798147dad",
  "OrderNumber": "sample string 2",
  "InvoiceId": "26f678ec-5e38-4e5e-9ad2-0a92cf8bdfe9",
  "Status": "sample string 4",
  "LocationId": 5,
  "InvoiceNumber": "sample string 6",
  "CustomerId": "cb6b032d-6cae-4740-88f1-e28b8a58cb47",
  "Products": [
    {
      "ProductId": "36afa866-e53c-4edf-9f90-77e5db44d9b3",
      "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": "36afa866-e53c-4edf-9f90-77e5db44d9b3",
      "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": "2024-11-25T11:19:25.6441632+00:00"
    },
    {
      "Last4Digits": "sample string 1",
      "CustomerAccountId": "sample string 2",
      "PaymentMethodId": 3,
      "PaymentMethodName": "sample string 4",
      "Amount": 5.1,
      "TransactionDateUtc": "2024-11-25T11:19:25.6441632+00:00"
    }
  ]
}