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
CovaSalesOrderGetOrderDetailsByIdReturnName | Description | 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": "7a374f3f-8136-428e-a64a-79bd72fcce10", "OrderNumber": "sample string 2", "InvoiceId": "a279378c-a1e8-4b47-95e3-e55b67b63469", "Status": "sample string 4", "LocationId": 5, "InvoiceNumber": "sample string 6", "CustomerId": "3e1ad2c0-ffc6-4f1e-9b1c-266447b313d8", "Products": [ { "ProductId": "d981cd67-6b5d-416b-a79c-c0ebe885805b", "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": "d981cd67-6b5d-416b-a79c-c0ebe885805b", "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-07T08:55:17.2016+00:00" }, { "Last4Digits": "sample string 1", "CustomerAccountId": "sample string 2", "PaymentMethodId": 3, "PaymentMethodName": "sample string 4", "Amount": 5.1, "TransactionDateUtc": "2024-11-07T08:55:17.2016+00:00" } ] }