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

Pulls Sales Order to be Fulfilled at a Location in a Company with Filtering

Information:

Base URL:

https://api.covasoft.net/pointofsale

Examples of this filterable call would be:

https://api.covasoft.net/pointofsale/Companies({CompanyId})/Locations({LocationId})/SalesToFulfill

Odata Filter Section:

SaleStatus eq 'PaidAndAwaitingCompletion'

Status eq 'ReadyForPickup' and Method eq 'Pickup'

Status eq 'ReadyForPickup' and Method eq 'Delivery'

ReceiptNumber eq '{ReceiptNumber}'

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 Sales Orders to Fulfill	integer	Required
filter	The Odata filter applied to this call, see filter section above	string	None.

Body Parameters

None.

Response Information

Resource Description

Returns Sales Order to be fulfilled at a Location with Filtering

Collection of GetSalesOrdersToFulfillReturn

Name	Type	Additional information
Id	globally unique identifier	None.
Created	date	None.
Source	string	None.
Method	string	None.
Reference	string	None.
OrderNumber	Object	None.
ReceiptNumber	string	None.
Status	string	None.
SaleStatus	string	None.
Address	Address	None.
Total	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "d03a67c6-33d3-4f10-81c2-f0584593f31f",
    "Created": "2024-11-25T11:18:04.5371425+00:00",
    "Source": "sample string 3",
    "Method": "sample string 4",
    "Reference": "sample string 5",
    "OrderNumber": {},
    "ReceiptNumber": "sample string 7",
    "Status": "sample string 8",
    "SaleStatus": "sample string 9",
    "Address": {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "City": "sample string 3",
      "StateName": "sample string 4",
      "CountryName": "sample string 5",
      "Zip": 1,
      "Id": "6f851987-1d1d-4f74-956a-41895bcf228e",
      "CustomerId": "2338c26d-2bf5-4464-b31c-dac2026c0c2a",
      "AddressTypeId": 8,
      "AddressType": "sample string 9",
      "Default": true,
      "DoNotContact": true,
      "CountryCode": "sample string 12",
      "Country": "sample string 13",
      "Locality": "sample string 14",
      "StateCode": "sample string 15",
      "State": "sample string 16",
      "PostalCode": "sample string 17",
      "PostOfficeBoxNumber": "sample string 18",
      "StreetAddress1": "sample string 19",
      "Notes": "sample string 20",
      "StreetAddress2": "sample string 21",
      "Version": 22,
      "AttentionTo": "sample string 23",
      "Phone": "sample string 24",
      "Email": "sample string 25"
    },
    "Total": 10.1
  },
  {
    "Id": "d03a67c6-33d3-4f10-81c2-f0584593f31f",
    "Created": "2024-11-25T11:18:04.5371425+00:00",
    "Source": "sample string 3",
    "Method": "sample string 4",
    "Reference": "sample string 5",
    "OrderNumber": {},
    "ReceiptNumber": "sample string 7",
    "Status": "sample string 8",
    "SaleStatus": "sample string 9",
    "Address": {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "City": "sample string 3",
      "StateName": "sample string 4",
      "CountryName": "sample string 5",
      "Zip": 1,
      "Id": "6f851987-1d1d-4f74-956a-41895bcf228e",
      "CustomerId": "2338c26d-2bf5-4464-b31c-dac2026c0c2a",
      "AddressTypeId": 8,
      "AddressType": "sample string 9",
      "Default": true,
      "DoNotContact": true,
      "CountryCode": "sample string 12",
      "Country": "sample string 13",
      "Locality": "sample string 14",
      "StateCode": "sample string 15",
      "State": "sample string 16",
      "PostalCode": "sample string 17",
      "PostOfficeBoxNumber": "sample string 18",
      "StreetAddress1": "sample string 19",
      "Notes": "sample string 20",
      "StreetAddress2": "sample string 21",
      "Version": 22,
      "AttentionTo": "sample string 23",
      "Phone": "sample string 24",
      "Email": "sample string 25"
    },
    "Total": 10.1
  }
]