GET v1/companies/{CompanyId}/entities/{LocationId}/integrators/{IntegratorId}/CompletedOrders?EntityId={EntityId}&DateSince={DateSince}&OrderSource={OrderSource}

Get all orders that were completed since date

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}/CompletedOrders?DateSince=2020-12-10T00:00:00.00Z&OrderSource=Online

Usage:

Use this endpoint to get the completed orders for an 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 entity the order was created at	integer	Required
IntegratorId	The integrator who created the order.	globally unique identifier	Required
DateSince	UTC date from date until now, with a maximum range of 30 days.	date	Required
OrderSource	Optional filter that will filter orders from a specific source. (eg, a specific tablet, a specific integrator, etc)	string	None.
LocationId		string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of CovaSalesOrderGetCompletedOrdersSinceReturn

Name	Type	Additional information
OrderId	globally unique identifier	None.
OrderNumber	string	None.
Total	decimal number	None.
OrderSource	string	None.
FulfillmentMethod	string	None.
CustomerID	globally unique identifier	None.
CreatedDateUtc	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "OrderId": "876d6d01-ee2a-4fcd-9a29-d66bb618171b",
    "OrderNumber": "sample string 2",
    "Total": 3.0,
    "OrderSource": "sample string 4",
    "FulfillmentMethod": "sample string 5",
    "CustomerID": "3a8b99d2-7086-478f-9d82-9e73d4c48c8b",
    "CreatedDateUtc": "2024-11-07T08:54:11.8707573+00:00"
  },
  {
    "OrderId": "876d6d01-ee2a-4fcd-9a29-d66bb618171b",
    "OrderNumber": "sample string 2",
    "Total": 3.0,
    "OrderSource": "sample string 4",
    "FulfillmentMethod": "sample string 5",
    "CustomerID": "3a8b99d2-7086-478f-9d82-9e73d4c48c8b",
    "CreatedDateUtc": "2024-11-07T08:54:11.8707573+00:00"
  }
]