Overview

OData v3 compliant

The latest version of the Decision Logic (DL) API is OData v3 compliant and allows various DL endpoints to be queried. Examples of all current DL endpoint usage are included throughout this document, but this is not intended to be an exhaustive OData resource.

Note:

• As of DL v6.17, collections marked by * have additional restrictions on their OData queries.

• All OData queries are case-sensitive.

• For more OData best practices, please see:

  • http://www.odata.org/getting-started/basic-tutorial/

  • http://www.odata.org/documentation/odata-version-3-0/

Anchor
_Toc114226777 _Toc114226777

Anchor
_Toc131426277 _Toc131426277

Quick Reference Endpoints

As of DL v6.17, collections marked by * have additional restrictions on their OData queries.

† - The endpoints are restricted based upon the scope assigned in Profile Maintenance. The profile must have at least View access to the required page. (See Figure 1.) The scope identifier is set on the Profiles tab. (See Figure 2.)
‡ - Items do not require an assigned page, though they require valid credentials in the request.
§ - The store restriction applies to the stores mapped to employees. If the ODATA user has access to store A but not store B, an employee at B will not appear until store A is mapped.

Figure 1. Profile Maintenance / Assigned pages

Figure 2. Profile Maintenance / Profiles

Anchor
_Toc114226778 _Toc114226778

Anchor
_Toc131426278 _Toc131426278

Authentication

The Decision Logic API uses a Basic Authentication header that is implemented as follows:

• A Username consists of an API key and the actual username separated by a colon:

  • Ie. 000000000000-0000-0000-000000000000:username

  • The password is a separate entry.

An example - a username of '1234567AA-R2D2-67B4-C3P0-789EB34MC516:helpdesk' and the current password for the helpdesk user. The username and password must belong to a valid user in Decision Logic.

Anchor
_Toc114226779 _Toc114226779

Anchor
_Toc131426279 _Toc131426279

Endpoint Roster

The Decision Logic API provides the user with a list of the available endpoints from which data can be queried.

Included in this list are collections which are only available as expand options and cannot be queried.

Retrieve a list of Decision Logic endpoints:

GET https://webapi.mydlweb.com/api/odata/v3

Example response:

<workspace>
<atom:title type="text">Default</atom:title>
<collection href="Checks">
<atom:title type="text">Checks</atom:title>
</collection>
	.
	.
	.
<collection href="OrderTypes">
<atom:title type="text">OrderTypes</atom:title>
</collection>
</workspace>

Anchor
_Toc114226780 _Toc114226780

Anchor
_Toc131426280 _Toc131426280

Expand Query Option

The Decision Logic API provides the user with a query option that allows clients to request related resources on specific endpoints. The expand options for an endpoint are included in its respective section.

Retrieve a list of available check details that includes related information about the store for each check:

GET https://webapi.mydlweb.com/api/odata/v3/Checks?$expand=Store

Example response:

<StoreId>140</StoreId> 
<CustomerStoreId>239</CustomerStoreId> 
<Address1>1234 N Rock Road</Address1> 
<City>Wichita</City> 
<State>KS</State> 
<ZipCode>67221</ZipCode> 
<PhoneNumber>321-555-1212</PhoneNumber> 
<TaxIncluded>false</TaxIncluded> 
<LiquorTax>0.0000</LiquorTax> 
<MinimumWage>0.00</MinimumWage> 
<StMinimumWage>0.00</StMinimumWage> 
<EODWorkflowId>1</EODWorkflowId>
<StoreId>140</StoreId> 
<Date>2015-09-24T00:00:00</Date> 
<CheckNumber>264</CheckNumber> 
<ServerId>0</ServerId> 
<StartTime>19:48</StartTime> 
<CloseTime>19:50</CloseTime> 
 	<Amount>128.51</Amount> 
<Tip>0.00</Tip> 
<CustomerCount>8</CustomerCount> 
<CreditCardFlag>0</CreditCardFlag> 
<OrderTypeId>0</OrderTypeId>

Anchor
_Toc114226781 _Toc114226781

Anchor
_Toc131426281 _Toc131426281

Filter Query Option

The Decision Logic API provides the user with a query option that allows clients to filter an OData response based upon criteria relative to the endpoints being used.

For more OData syntax rules, please see http://www.odata.org/documentation/odata-version-3-0/

Retrieve a complete sales summary of all stores on 10/10/17:

GET http://webapi.mydlweb.com/api/odata/v3/SalesSummary?$filter=Date eq DateTime'2017-10-10'

Example Response:

<SaleSummary>
<Id>c36b9cc8-29cb-4337-81aa3bf5c6748edf</Id>
<RecordID>1</RecordID>
<RecordName>Gross Sales</RecordName>
<StoreID>0</StoreID>
<CustomerStoreID>0</CustomerStoreID>
<StoreName>9999 - Gibbon</StoreName>
<Date>2017-10-10T00:00:00</Date>
<DepartmentID>222</DepartmentID>
<DepartmentName>Non-Alc Bevs</DepartmentName>
 	<TypeID>0</TypeID>
 	<TypeName/>
 	<Amount>104.60</Amount>
 	<Tip>0.00</Tip>
 	<CashBack>0.00</CashBack>
  	<Reason/>
<AccountId/>
</SaleSummary> 
. 
.	
.
<SaleSummary> 
<Id>1e981a2d-8160-460e-95d7b8b75768bc58</Id> 
<RecordID>5</RecordID> 
<RecordName>Payments</RecordName> 
<StoreID>0</StoreID> 
<CustomerStoreID>0</CustomerStoreID> 
<StoreName>9999 - Gibbon</StoreName> 
<Date>2017-10-10T00:00:00</Date> 
<DepartmentID>300</DepartmentID> 
<DepartmentName/> 
<TypeID>301</TypeID> 
<TypeName>Visa</TypeName> 
<Amount>462.88</Amount> 
<Tip>0.00</Tip> 
<CashBack>0.00</CashBack> 
<Reason/> 
<AccountId/> 
</SaleSummary>

Anchor
_Toc114226782 _Toc114226782

Anchor
_Toc131426282 _Toc131426282

Metadata

The Decision Logic API provides the user with a list of the fields of data from each of the available endpoints.

Retrieve a list of fields contained within each of the available Decision Logic endpoints:

GET https://webapi.mydlweb.com/api/odata/v3/$metadata/

Example response:

<EntityType Name="Job">
<Key> 
<PropertyRef Name="ID"/> 
</Key> 
<Property Name="ID" Type="Edm.Int32" Nullable="false"/> 
<Property Name="Name" Type="Edm.String"/> 
<Property Name="IsBOH" Type="Edm.Int32" Nullable="false"/> 
<Property Name="Account" Type="Edm.String"/> 
<Property Name="Active" Type="Edm.Int32" Nullable="false"/>
</EntityType> >

Anchor
_Toc114226783 _Toc114226783

Anchor
_Toc60735 _Toc60735

Anchor
_Toc131426283 _Toc131426283

Multiple Query Options

The Decision Logic API provides the ability to combine multiple query options. This allows clients to expand, filter, and/or control the page size in an OData response based upon criteria relative to the endpoints being used.

For more OData syntax rules, please see http://www.odata.org/documentation/odata-version-3-0/

Retrieve a complete sales summary of all stores on 10/10/17 with a page size of 20 records:

GET http://webapi.mydlweb.com/api/odata/v3/SalesSummary?$filter=Date eq DateTime'2017-10-

10'&pagesize=20

Example response:

<SaleSummary> 
 	<Id>c36b9cc8-29cb-4337-81aa-3bf5c6748edf</Id> 
 	<RecordID>1</RecordID> 
 	<RecordName>Gross Sales</RecordName> 
 	<StoreID>0</StoreID> 
 	<CustomerStoreID>0</CustomerStoreID> 
 	<StoreName>9999 - Gibbon</StoreName> 
 	<Date>2017-10-10T00:00:00</Date> 
 	<DepartmentID>222</DepartmentID> 
<DepartmentName>Non-Alc Bevs</DepartmentName> 
 	<TypeID>0</TypeID> 
 	<TypeName/> 
 	<Amount>104.60</Amount> 
 	<Tip>0.00</Tip> 
 	<CashBack>0.00</CashBack> 
 	 	<Reason/> 
<AccountId/> 
</SaleSummary>
.
.
.
<SaleSummary> 
<Id>1e981a2d-8160-460e-95d7-b8b75768bc58</Id> 
 	<RecordID>5</RecordID> 
 	<RecordName>Payments</RecordName> 
 	<StoreID>0</StoreID> 
 	<CustomerStoreID>0</CustomerStoreID> 
 	<StoreName>9999 - Gibbon</StoreName> 
 	<Date>2017-10-10T00:00:00</Date> 
 	<DepartmentID>300</DepartmentID> 
 	<DepartmentName/> 
 	<TypeID>301</TypeID> 
 	<TypeName>Visa</TypeName> 
 	<Amount>462.88</Amount> 
 	<Tip>0.00</Tip> 
 	<CashBack>0.00</CashBack> 
 	<Reason/>&page 
 	<AccountId/> 
</SaleSummary>

Anchor
_Toc114226784 _Toc114226784

Anchor
_Toc60736 _Toc60736

Anchor
_Toc131426284 _Toc131426284

Pagesize Query Option

The Decision Logic API is set to display a default page size of 1000 records for an OData query response. This default should prevent an out of memory exception on requests of large amounts of data.

The user can override the default page size of an OData query response by using the pagesize option:

Retrieve a list of Product Mix with a list size of 100 records (instead of the default 1000 records)

GET http://webapi.mydlweb.com/api/odata/v3/ProductMix?pagesize=100

The user can also override the default page size and return all the records of an OData query response.

This is NOT recommended since it increases the likelihood of an out of memory exception.

Retrieve a list of Product Mix with a list size of all records (instead of the default 1000 records)

GET http://webapi.mydlweb.com/api/odata/v3/ProductMix?pagesize=0

IMPORTANT! At the bottom of an OData query page, there is a known issue with the URL links (they contain improper XML syntax). We strongly recommend not clicking these links since they can return inconsistent data from the intended query.

Anchor
_Toc114226785 _Toc114226785

Anchor
_Toc131426285 _Toc131426285

Endpoints with Examples

Anchor
_Toc60738 _Toc60738

Anchor
_Toc114226786 _Toc114226786

Anchor
_Toc131426286 _Toc131426286

Checks

The Checks endpoint allows a user to query check details. It also allows Store and Order Type as expand options.

Retrieve a list of check details

GET https://webapi.mydlweb.com/api/odata/v3/Checks (see Example A)

Retrieve a list of check details that includes related information about the store and/or order type for each check:

Example Responses:

• Example A

• GET https://webapi.mydlweb.com/api/odata/v3/Checks?$expand=OrderType

• GET https://webapi.mydlweb.com/api/odata/v3/Checks?$expand=Store,OrderType

<Checks> 
      <StoreId>140</StoreId> 
      <Date>2015-09-24T00:00:00</Date> 
      <CheckNumber>264</CheckNumber> 
      <ServerId>0</ServerId> 
      <StartTime>19:48</StartTime> 
      <CloseTime>19:50</CloseTime> 
      <Amount>228.51</Amount> 
      <Tip>0.00</Tip> 
      <CustomerCount>8</CustomerCount> 
      <CreditCardFlag>0</CreditCardFlag> 
      <OrderTypeId>0</OrderTypeId> 
  </Checks>

• Example B

• GET https://webapi.mydlweb.com/api/odata/v3/Checks?$expand=Store

<Store> 
<StoreId>140</StoreId> 
<CustomerStoreId>239</CustomerStoreId> 
<Address1>3130 N Rock Road</Address1> 
<City>Wichita</City> 
<State>KS</State> 
<ZipCode>67221</ZipCode> 
<PhoneNumber>321-555-1212</PhoneNumber> 
<TaxIncluded>false</TaxIncluded> 
<LiquorTax>0.0000</LiquorTax> 
<MinimumWage>0.00</MinimumWage> 
<StMinimumWage>0.00</StMinimumWage> 
<EODWorkflowId>1</EODWorkflowId> 
</Store> 
<Checks> 
        <StoreId>140</StoreId> 
        <Date>2015-09-24T00:00:00</Date> 
        <CheckNumber>264</CheckNumber> 
        <ServerId>0</ServerId> 
        <StartTime>19:48</StartTime> 
        <CloseTime>19:50</CloseTime> 
        <Amount>128.51</Amount> 
        <Tip>0.00</Tip> 
        <CustomerCount>8</CustomerCount> 
        <CreditCardFlag>0</CreditCardFlag>
<OrderTypeId>0</OrderTypeId> 
</Checks>

Anchor
_Toc60739 _Toc60739

Anchor
_Toc114226787 _Toc114226787

Anchor
_Toc131426287 _Toc131426287

Departments

The Departments endpoint allows a user to query department information.

Retrieve a list of all departments

GET https://webapi.mydlweb.com/api/odata/v3/Departments?$filter=DepartmentId lt 4

Example response:

<Departments> 
    <DepartmentId>1</DepartmentId> 
    <Name>Food</Name> 
    <SaleTypeId>1</SaleTypeId> 
    <Active>1</Active> 
    <IsIncluded>1</IsIncluded> 
    <AccountNumber/> 
</Departments> 
<Departments> 
    <DepartmentId>2</DepartmentId> 
    <Name>Non-Alc Bevs</Name> 
    <SaleTypeId>1</SaleTypeId> 
    <Active>1</Active> 
    <IsIncluded>1</IsIncluded> 
    <AccountNumber/> 
</Departments> 
<Departments> 
    <DepartmentId>3</DepartmentId> 
    <Name>Beer</Name> 
    <SaleTypeId>2</SaleTypeId> 
    <Active>1</Active> 
    <IsIncluded>1</IsIncluded> 
    <AccountNumber/> 
	</Departments>

Anchor
_Toc60740 _Toc60740

Anchor
_Toc114226788 _Toc114226788

Anchor
_Toc131426288 _Toc131426288

Employee Custom Fields

The Employee Custom Fields endpoint allows a user to query employee custom fields and their respective entries.

Retrieve a list of all employee custom fields for all employees

GET https://webapi.mydlweb.com/api/odata/v3/EmployeeCustomFields

Retrieve a list of employee custom fields for Employee ID 967

GET https://webapi.mydlweb.com/api/odata/v3/EmployeeCustomFields?$filter=EmployeeID eq 967

Example response:

<EmployeeCustomField> 
	 	<EmployeeID>967</EmployeeID> 
	 	<FieldID>1</FieldID> 
	 	<FieldName>Gender</FieldName> 
	 	<Value>Female</Value> 
</EmployeeCustomField> 
<EmployeeCustomField> 
	 	<EmployeeID>967</EmployeeID> 
	 	<FieldID>2</FieldID> 
	 	<FieldName>Filing Status</FieldName> 
 	<Value>Single</Value> </EmployeeCustomField> 
<EmployeeCustomField> 
	 	<EmployeeID>967</EmployeeID> 
	 	<FieldID>3</FieldID> 
	 	<FieldName>Federal Exemptions</FieldName> 
	 	<Value>1</Value> 
</EmployeeCustomField> 
<EmployeeCustomField> 
	 	<EmployeeID>967</EmployeeID> 
	 	<FieldID>4</FieldID> 
	 	<FieldName>Additional State Withholding Needed</FieldName> 
	 	<Value>No</Value> 
</EmployeeCustomField> 
<EmployeeCustomField> 
	 	<EmployeeID>967</EmployeeID> 
	 	<FieldID>8</FieldID> 
	 	<FieldName>Payroll ID - ADP number</FieldName> 
	 	<Value>001430</Value> 
</EmployeeCustomField>

Anchor
_Toc114226789 _Toc114226789

Anchor
_Toc60741 _Toc60741

Anchor
_Toc131426289 _Toc131426289

Employee Jobs

The Employee Jobs API endpoint allows a user to query employees and their respective jobs.

Retrieve a list of employees and their respective jobs

GET https://webapi.mydlweb.com/api/odata/v3/EmployeeJobs

⚠️ WARNING: running such a query without the page size default will take a long time and may result in out of memory exceptions or other technical difficulties.

Retrieve a list of employee jobs for Employee ID 967

GET https://webapi.mydlweb.com/api/odata/v3/EmployeeJobs?$filter=EmployeeID eq 967

Example response:

<EmployeeJob> 
	 	<EmployeeID>967</EmployeeID> 
	 	<JobID>15</JobID> 
	 	<StoreID>8</StoreID> 
	 	<CustomerStoreID>10</CustomerStoreID> 
	 	<EmpNumber>321</EmpNumber> 
	 	<JobCode>101</JobCode> 
	 	<JobName>Clock in Emp</JobName> 
	 	<POSNumber>304</POSNumber> 
	 	<PayRate>15.00</PayRate> 
</EmployeeJob> 
<EmployeeJob> 
	 	<EmployeeID>967</EmployeeID> 
	 	<JobID>27</JobID> 
	 	<StoreID>8</StoreID> 
	 	<CustomerStoreID>10</CustomerStoreID> 
	 	<EmpNumber>321</EmpNumber> 
	 	<JobCode>217</JobCode> 
	 	<JobName>Hourly Manager</JobName> 
	 	<POSNumber>406</POSNumber> 
	 	 <PayRate>15.00</PayRate> 
	</EmployeeJob>

Anchor
_Toc114226790 _Toc114226790

Anchor
_Toc60742 _Toc60742

Anchor
_Toc131426290 _Toc131426290

Employee Transactions

The Employee Transactions endpoint allows a user to query employee transactions.

Retrieve a list of employee transactions

GET https://webapi.mydlweb.com/api/odata/v3/EmployeeTransactions

WARNING: running such a query without the page size default will take a long time and may result in out of memory exceptions or other technical difficulties.

Retrieve a list of employee transactions for EmployeeID 967

GET https://webapi.mydlweb.com/api/odata/v3/EmployeeTransactions?$filter=EmployeeID eq 967

Example response:

<EmployeeTransaction>

<EmployeeID>967</EmployeeID>

<EmpNumber>301342</EmpNumber>

<TranType>4</TranType>

<TranTypeName>Term</TranTypeName>

<StoreID>31</StoreID>

<CustomerStoreID>22</CustomerStoreID>

<TranDate>2016-12-16T00:00:00</TranDate>

<HireDate>2016-12-16T00:00:00</HireDate>

<TermComment>Submitted fake customer comments.</TermComment>

<TermReason>Unprofessional Behavior</TermReason>

<TermName>Insubordination</TermName>

<TimeStamp>2017-01-30T08:09:00</TimeStamp>

</EmployeeTransaction>

<EmployeeTransaction>

<EmployeeID>967</EmployeeID>

<EmpNumber>301342</EmpNumber>

<TranType>5</TranType>

<TranTypeName>Re-Hire</TranTypeName>

<StoreID>31</StoreID>

<CustomerStoreID>22</CustomerStoreID>

<TranDate>2017-05-16T00:00:00</TranDate>

<HireDate>2017-05-16T00:00:00</HireDate>

<TimeStamp>2017-05-16T12:10:00</TimeStamp>

</EmployeeTransaction>

Anchor
_Toc114226791 _Toc114226791

Anchor
_Toc131426291 _Toc131426291

Employee Stores

The Employee Stores endpoint allows a user to query store details for individual employees.

Retrieve a list of employees with their store details:

GET https://webapi.mydlweb.com/api/odata/v3/EmployeeStores

WARNING: running such a query without the page size default will take a long time and may result in out of memory exceptions or other technical difficulties.

Retrieve a list of employees with their store details for Employee IDs less than 100:

GET https://webapi.mydlweb.com/api/odata/v3/EmployeeStores?$filter=ID lt 100

Example response:

<EmployeeStores>

<EmployeeID>25<EmployeeID>

<ID>19<ID>

<CustomerStoreID>8<CustomerStoreID>

<Name>0028 - Park Drive<Name>

</EmployeeStores>

<EmployeeStores>

<EmployeeID>53<EmployeeID>

<ID>127<ID>

<CustomerStoreID>36<CustomerStoreID>

<Name>0063 - Bellevue<Name>

</EmployeeStores>

<EmployeeStores>

<EmployeeID>65<EmployeeID>

<ID>33<ID>

<CustomerStoreID>1<CustomerStoreID>

<Name>0011 - Orchard<Name>

</EmployeeStores>

Anchor
_Toc114226792 _Toc114226792

Anchor
_Toc60744 _Toc60744

Anchor
_Toc131426292 _Toc131426292

Employees

The Employees endpoint allows a user to query employee details. It also allows the following as expand options:

• Custom Fields

• Stores

• Jobs

• Transactions

Retrieve a list of employees and their details:

GET https://webapi.mydlweb.com/api/odata/v3/Employees

WARNING: running such a query without the page size default will take a long time and may result in out of memory exceptions or other technical difficulties.

Retrieve a list of employee details for ID less than 100

• Example A:

• GET https://webapi.mydlweb.com/api/odata/v3/Employees?$filter=ID lt 10

<Employees>

<ID>99<ID>

<SSN>045642596<SSN>

<FirstName>Samantha<FirstName>

<MiddleName><MiddleName>

<LastName>Pedowitz<LastName>

<DOB>1979-04-29T00:00:00<DOB>

<Address>1117 TOWBRIDGE<Address>

<Address2><Address2>

<City>KELLER<City>

<State>TX<State>

<Zip>61249<Zip>

<Phone>7892469705<Phone>

<Phone2>7892469705<Phone2>

<EmergencyContact><EmergencyContact>

<EmergencyPhone>7892469705<EmergencyPhone>

<NextRev>2018-01-11T00:00:00<NextRev>

</Employees>

Retrieve a list of employee details that includes related information about the custom fields, jobs, stores and/or transactions for each employee:

• Example B:

• GET https://webapi.mydlweb.com/api/odata/v3/Employees?$expand=Jobs

• GET https://webapi.mydlweb.com/api/odata/v3/Employees?$expand=Stores

• GET https://webapi.mydlweb.com/api/odata/v3/Employees?$expand=Transactions

• GET https://webapi.mydlweb.com/api/odata/v3/Employees?$expand=Stores,Jobs

• GET https://webapi.mydlweb.com/api/odata/v3/Employees?$expand=CustomFields

<CustomFields>

<EmployeeID>25</EmployeeID>

<FieldID>1</FieldID>

<FieldName>Gender</FieldName>

<Value>Male</Value>

</CustomFields>

<CustomFields>

<EmployeeID>25</EmployeeID>

<FieldID>2</FieldID>

<FieldName>Gender</FieldName>

<Value>Male</Value>

</CustomFields>

.

.

.

<Employees>

<ID>25</ID>

<SSN>777022818</SSN>

<FirstName>Freddie</FirstName>

<MiddleName>F</MiddleName>

<LastName>Fieber</LastName>

.

.

.

<EmergContact>Sam Bamm</EmergContact>

<EmergPhone>4025558531</EmergPhone>

<NextRev>2017-10-15T00:00:00</NextRev>

<Employees>

Anchor
_Toc60745 _Toc60745

Anchor
_Toc114226793 _Toc114226793

Anchor
_Toc131426293 _Toc131426293

Hot Items IvA Summary

The Hot Items IvA Summary endpoint allows a user to query summary of Hot Items IvA details.

Retrieve a summary of Hot Items IvA details

GET https://webapi.mydlweb.com/api/odata/v3/HotItemsIvASummary

WARNING: running such a query without the page size default will take a long time and may result in out of memory exceptions or other technical difficulties.

Retrieve a summary of Hot Items IvA details on Product ID = 999

GET https://webapi.mydlweb.com/api/odata/v3/HotItemsIvASummary?$filter=ProductID eq 999

Example response:

<HotItemsIvASummary >

<StoreId>99</StoreId>

<CustomerStoreId>1</CustomerStoreId>

<InventoryId>3999</InventoryId>

<ProductId>999</ProductId>

<ProductDescription>Pork Shredded</ProductDescription>

<BeginQuantity/>

<EndQuantity>0.000</EndQuantity>

<IdealQuantity>0.000</IdealQuantity>

<ActualQuantity/>

<VarianceQuantity/>

<Date>2017-08-03T00:00:00</Date>

<ReceivedQuantity>0.000</ReceivedQuantity>

<PricePerQuantity>0.290</PricePerQuantity>

<RecipeMeasure>OZ (W)</RecipeMeasure>

<InventoryMeasure>LB</InventoryMeasure> <RecipeMultiplier>16.000</RecipeMultiplier>

<InventoryMultiplier>20.000</InventoryMultiplier>

</HotItemsIvASummary >

Anchor
_Toc114226794 _Toc114226794

Anchor
_Toc60746 _Toc60746

Anchor
_Toc131426294 _Toc131426294

Jobs

The Jobs endpoint allows a user to query job details.

Retrieve a list of jobs and their details

GET https://webapi.mydlweb.com/api/odata/v3/Jobs

WARNING: running such a query without the page size default will take a long time and may result in out of memory exceptions or other technical difficulties.

Retrieve a list of job details for ID less than 4

GET https://webapi.mydlweb.com/api/odata/v3/Jobs?$filter=ID lt 4

Example response:

<Jobs>

<ID>1</ID>

<Name>TP Girl</Name>

<IsBOH>0</IsBOH>

<Account>6020</Account>

<Active>1</Active>

</Jobs>

<Jobs>

<ID>2</ID>

<Name>TP Bar AM</Name>

<IsBOH>0</IsBOH>

<Account>6020</Account>

<Active>1</Active>

</Jobs>

<Jobs>

<ID>3</ID>

<Name>TP Bar PM</Name>

<IsBOH>0</IsBOH>

<Account>6020</Account>

<Active>1</Active>

</Jobs>

Anchor
_Toc114226795 _Toc114226795

Anchor
_Toc131426295 _Toc131426295

Line Types

The Line Types endpoint allows a user to query line types details.

Retrieve a list of line types

GET https://webapi.mydlweb.com/api/odata/v3/LineTypes

Example response:

<LineTypes>

<LineTypeId>1</LineTypeId>

<Name>Sale</Name>

<Count>1</Count>

<Dollars>1</Dollars>

</LineTypes>

<LineTypes>

<LineTypeId>2</LineTypeId>

<Name>Complaint</Name>

<Count>0</Count>

<Dollars>-1</Dollars>

</LineTypes>

<LineTypes>

<LineTypeId>3</LineTypeId>

<Name>Void</Name>

<Count>-1</Count>

<Dollars>-1</Dollars>

</LineTypes>

Anchor
_Toc114226796 _Toc114226796

Anchor
_Toc131426296 _Toc131426296

Menu Items

The Menu Items endpoint allows a user to query menu items info. It also allows Category as an expand option.

Retrieve a list of menu items

GET https://webapi.mydlweb.com/api/odata/v3/MenuItems

Retrieve a list of menu items that includes related information about the menu item category for each menu item

GET https://webapi.mydlweb.com/api/odata/v3/MenuItems?$filter= StoreID eq 16 (see Example A)

GET https://webapi.mydlweb.com/api/odata/v3/MenuItems?$expand=Category (see Example B)

Example A:

<MenuItems>

<ID>1</ID>

<StoreID>16</StoreID>

<StoreName>0016</ StoreName >

<MenuSetID>1</MenuSetID>

<MenuSetName>Default</MenuSetName>

<MenuNumber>160001</MenuNumber>

<MenuName>Bud-160001</MenuName>

<Price>3.50</Price>

<CoverCount>0.00</CoverCount>

<CategoryID>7</CategoryID>

<CategoryName>Red Wine</CategoryName>

<DepartmentID>203</DepartmentID>

<DepartmentName>Wine</DepartmentName >

</MenuItems>

.

.

.

<MenuItems>

<ID>1</ID>

<StoreID>16</StoreID>

<StoreName>0016</ StoreName >

<MenuSetID>1</MenuSetID>

<MenuSetName>Default</MenuSetName>

<MenuNumber>165006</MenuNumber>

<MenuName>Steak Burrito</MenuName>

<Price>8.50</Price>

<CoverCount>0.00</CoverCount>

<CategoryID>35</CategoryID>

<CategoryName>Burritos</CategoryName>

<DepartmentID>101</DepartmentID>

<DepartmentName>Food</DepartmentName > </MenuItems>

Example B:

<Category>

<ID>21</ID>

<Name>Bottled Beer</Name>

<Active>1</Active>

</Category>

<MenuItems>

<ID>1</ID>

<StoreID>1</StoreID>

<StoreName>0016</ StoreName >

<MenuSetID>1</MenuSetID>

<MenuSetName>Default</MenuSetName>

<MenuNumber>165006</MenuNumber>

<MenuName>Bud-165006</MenuName>

<Price>3.50</Price>

<CoverCount>0.00</CoverCount>

<CategoryID>21</CategoryID>

<CategoryName> Bottled Beer </CategoryName>

<DepartmentID>303</DepartmentID>

<DepartmentName>Beer</DepartmentName >

</MenuItems>

<Category>

<ID>21</ID>

<Name>Bottled Beer</Name>

<Active>1</Active>

</Category>

<MenuItems>

<ID>1</ID>

<StoreID>2</StoreID>

<StoreName>0017</StoreName >

Anchor
_Toc114226797 _Toc114226797

Anchor
_Toc131426297 _Toc131426297

Menu Item Categories

The Menu Item Categories endpoint allows a user to query menu item categories info. It also allows Menu Items as an expand option.

Retrieve a list of menu item categories

GET https://webapi.mydlweb.com/api/odata/v3/MenuItemCategories

Retrieve a list of menu item categories that includes related information about the menu item for each menu item category

GET https://webapi.mydlweb.com/api/odata/v3/MenuItemCategories?$filter= StoreID eq 16 (see Example A)

GET https://webapi.mydlweb.com/api/odata/v3/MenuItemCategories?$expand=MenuItems (see Example B)

Anchor
_Toc114226798 _Toc114226798

Anchor
_Toc60750 _Toc60750

Anchor
_Toc131426298 _Toc131426298

Order Types

The Order Types endpoint allows a user to query order type details.

Retrieve a list of order types

GET https://webapi.mydlweb.com/api/odata/v3/OrderTypes

Example response:

<OrderTypes>

<OrderTypeId>11</OrderTypeId>

<Name>Dine In</Name>

<Active>1</Active>

<AccountNumber/>

</OrderTypes>

<OrderTypes>

<OrderTypeId>22</OrderTypeId>

<Name>Take Out</Name>

<Active>1</Active>

<AccountNumber/>

</OrderTypes>

<OrderTypes>

<OrderTypeId>33</OrderTypeId>

<Name>Drive Thru</Name>

<Active>1</Active>

<AccountNumber/>

</OrderTypes>

<OrderTypes>

<OrderTypeId>44</OrderTypeId>

<Name>Phone Out</Name>

<Active>1</Active>

<AccountNumber/>

</OrderTypes>

Anchor
_Toc114226799 _Toc114226799

Anchor
_Toc60751 _Toc60751

Anchor
_Toc131426299 _Toc131426299

Plate Cost And Sale Price

The Plate Cost And Sale Price endpoint allows a user to query plate cost and sale price details.

Retrieve a list of plate cost and prices by store

GET https://webapi.mydlweb.com/api/odata/v3/PlateCostAndSalePrice?CustomerStoreId=1

Note that the endpoint requires the CustomerStoreId parameter to be specified.

Example response:

<PlateCostAndSalePrice>

<CustomerStoreId>1</CustomerStoreId>

<MenuItem>249</MenuItem>

<MenuNumber>1605</MenuNumber>

<MenuDescription>Chili Veg</MenuDescription>

<PlateCost>0.233</PlateCost>

<SalePrice>7.00</SalePrice>

<UseMenuSetPrice>1</UseMenuSetPrice>

<FoodCostPercentage>0.033</FoodCostPercentage>

</PlateCostAndSalePrice>

<PlateCostAndSalePrice>

<CustomerStoreId>1</CustomerStoreId>

<MenuItem>354</MenuItem>

<MenuNumber>2810</MenuNumber>

<MenuDescription>Side Salad BYO</MenuDescription>

<PlateCost>0.260</PlateCost>

<SalePrice>5.00</SalePrice>

<UseMenuSetPrice>1</UseMenuSetPrice>

<FoodCostPercentage>0.052</FoodCostPercentage>

</PlateCostAndSalePrice>

.

.

.

<