GET Companies({CompanyId})/Locations({LocationId})/CompletedOrders?filter={filter}

Returns Completed orders for a Company by Date Range with Filtering

Information:

Base URL:

https://api.covasoft.net/pointofsale

Example of a call would be:

https://api.covasoft.net/pointofsale/Companies({CompanyId})/Locations({LocationId})/CompletedOrders?$filter=Created ge datetimeoffset'2019-09-01T00:00:00.000Z' and Created le datetimeoffset'2019-09-20T15:59:59.999Z'&$top=100&$skip=0

Odata Filters

Required: Created ge datetimeoffset'{UTCdatetime}' and Created le datetimeoffset'{UTCdatetime}'

FulfillmentMethod eq '{FulfillmentMethod}'

Source eq '{Source}'

Normal Odata pagings with $top & $skip

Request Information

URI Parameters

Name	Description	Type	Additional information
CompanyId	The unique Company Id that was provided in your onboarding pacakage.	integer	Required
LocationId	This is Location Id where you want to get the Completed Sales Orders	integer	Required
filter	The Odata filter applied to this call, see Odata filter section above	string	Required

Body Parameters

None.

Response Information

Resource Description

Completed orders for a Company by Date Range with Filtering

Collection of GetCompletedOrdersByDateRangeReturn

Name	Type	Additional information
Id	globally unique identifier	None.
ReceiptNumber	string	None.
Created	date	None.
Source	string	None.
FulfillmentMethod	string	None.
Reference	string	None.
OrderNumber	string	None.
Status	string	None.
DeliveryAddress	DeliveryAddress	None.
CustomerId	globally unique identifier	None.
Total	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "86bedf7f-1334-4cdf-8fb4-4d3097abe4f2",
    "ReceiptNumber": "sample string 2",
    "Created": "2024-11-25T11:55:11.0703919+00:00",
    "Source": "sample string 4",
    "FulfillmentMethod": "sample string 5",
    "Reference": "sample string 6",
    "OrderNumber": "sample string 7",
    "Status": "sample string 8",
    "DeliveryAddress": {
      "CountryCode": "sample string 1",
      "Locality": "sample string 2",
      "StateCode": "sample string 3",
      "PostalCode": 1,
      "PostOfficeBoxNumber": "sample string 4",
      "StreetAddress1": "sample string 5",
      "StreetAddress2": "sample string 6"
    },
    "CustomerId": "f92f7e6b-ffe8-4824-b029-95c975d2ae0c",
    "Total": 10.1
  },
  {
    "Id": "86bedf7f-1334-4cdf-8fb4-4d3097abe4f2",
    "ReceiptNumber": "sample string 2",
    "Created": "2024-11-25T11:55:11.0703919+00:00",
    "Source": "sample string 4",
    "FulfillmentMethod": "sample string 5",
    "Reference": "sample string 6",
    "OrderNumber": "sample string 7",
    "Status": "sample string 8",
    "DeliveryAddress": {
      "CountryCode": "sample string 1",
      "Locality": "sample string 2",
      "StateCode": "sample string 3",
      "PostalCode": 1,
      "PostOfficeBoxNumber": "sample string 4",
      "StreetAddress1": "sample string 5",
      "StreetAddress2": "sample string 6"
    },
    "CustomerId": "f92f7e6b-ffe8-4824-b029-95c975d2ae0c",
    "Total": 10.1
  }
]