NAV Navigation
C# curl Java Node Python Ruby

Delaget API v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

This api is based on REST principles. To gain access you will need a API Key, please contact Delaget support to have a API key created for you. All requests to the Delaget API must be via HTTPS.

Usage Scenarios:

Retrieving daily transactional data for an organization:

  1. For the organization make a call to /organizations.
  2. Inspect the response: organization.locations for a list of locations.
  3. For each location in the list call /organizations/{organization_code}/locations/{location_id}/retail_transactions

Retrieving daily financial data for an organization:

  1. For the organization make a call to /organizations.
  2. Inspect the response: organization.locations for a list of locations.
  3. For each location in the list call /organizations/{organization_code}/locations/{location_id}/summary

Retrieving daily time punch data for an organization:

  1. For the organization make a call to /organizations.
  2. Inspect the response: organization.locations for a list of locations.
  3. For each location in the list call /organizations/{organization_code}/locations/{location_id}/time_cards

Notes:

Base URLs:

Email: Support

Authentication

Organization

List organizations the caller has access to

Code samples

var client = new RestClient("https://api.delaget.com/api/v1/organizations");
var request = new RestRequest(Method.GET);
request.AddHeader("apikey", "API_KEY");
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);
curl --request GET \
  --url https://api.delaget.com/api/v1/organizations \
  --header 'accept: application/json' \
  --header 'apikey: API_KEY'
HttpResponse response = Unirest.get("https://api.delaget.com/api/v1/organizations")
  .header("accept", "application/json")
  .header("apikey", "API_KEY")
  .asString();
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.delaget.com/api/v1/organizations");
xhr.setRequestHeader("accept", "application/json");
xhr.setRequestHeader("apikey", "API_KEY");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.delaget.com")

headers = {
    'accept': "application/json",
    'apikey': "API_KEY"
    }

conn.request("GET", "/api/v1/organizations", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
require 'uri'
require 'net/http'

url = URI("https://api.delaget.com/api/v1/organizations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["apikey"] = 'API_KEY'

response = http.request(request)
puts response.read_body

GET /organizations

Parameters

Name In Type Required Description
after query string false return records after to this cursor
limit query integer(int32) false maximum number of records to return

Example responses

200 Response

{
  "data": {},
  "paging": {
    "cursor": {
      "after": "string"
    },
    "next": "string"
  },
  "available_requests": 0
}

Responses

Status Meaning Description Schema
200 OK Results matching the input parameters, response envelope contains an array of organization. Inline
400 Bad Request bad input parameter None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden - you cannot access the resource you are attempting to access. None
429 Too Many Requests Too Many Requests - More requests have been made in the last minute than your account is permitted None
500 Internal Server Error Unspecifed processing error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» data object false none none
» paging paging false none none
»» cursor cursors false none none
»»» after string false none This cursor points to the end of the page that has been returned
»» next string false none The endpoint next results based on the cursor
» available_requests number false none The number of requests the caller can make before getting a HTTP 429 (Too Many Requests) response

Retrieves an organization's details

Code samples

var client = new RestClient("https://api.delaget.com/api/v1/organizations/string");
var request = new RestRequest(Method.GET);
request.AddHeader("apikey", "API_KEY");
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);
curl --request GET \
  --url https://api.delaget.com/api/v1/organizations/string \
  --header 'accept: application/json' \
  --header 'apikey: API_KEY'
HttpResponse response = Unirest.get("https://api.delaget.com/api/v1/organizations/string")
  .header("accept", "application/json")
  .header("apikey", "API_KEY")
  .asString();
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.delaget.com/api/v1/organizations/string");
xhr.setRequestHeader("accept", "application/json");
xhr.setRequestHeader("apikey", "API_KEY");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.delaget.com")

headers = {
    'accept': "application/json",
    'apikey': "API_KEY"
    }

conn.request("GET", "/api/v1/organizations/string", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
require 'uri'
require 'net/http'

url = URI("https://api.delaget.com/api/v1/organizations/string")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["apikey"] = 'API_KEY'

response = http.request(request)
puts response.read_body

GET /organizations/{organization_code}

Retrieves details about one organization.

Parameters

Name In Type Required Description
organization_code path string true identifier for the organization

Example responses

200 Response

{
  "data": {},
  "paging": {
    "cursor": {
      "after": "string"
    },
    "next": "string"
  },
  "available_requests": 0,
  "code": "YCI",
  "name": "Your restaurants incorporated",
  "locations": [
    {
      "location_id": 1234,
      "location_number": 12345,
      "organization_location_identifier": "012345 - Rice Street",
      "name": "Lake Street",
      "open_date": "2017-02-01",
      "close_date": "2018-02-01",
      "address": {
        "street": "100 Main Street",
        "suite": "400 east",
        "city": "Anytown",
        "county": "County",
        "state": "MN",
        "zip": "01234",
        "zip_plus_four": "1234"
      },
      "workers": [
        {
          "id": "1234wsa",
          "first_name": "John",
          "last_name": "Doe",
          "middle_initial": "M",
          "phone": "4088675309",
          "alternative_phone": "string",
          "email": "user@example.com",
          "hire_date": "2017-02-01",
          "birth_date": "2000-02-01",
          "term_code": "string",
          "term_date": "2017-02-01",
          "gender": "Female",
          "address": {
            "street": "100 Main Street",
            "suite": "400 east",
            "city": "Anytown",
            "county": "County",
            "state": "MN",
            "zip": "01234",
            "zip_plus_four": "1234"
          },
          "client_worker_identification": {
            "company_code": "string",
            "identifier": "string"
          }
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Results matching the input parameters, response envelope contains a organization object. Inline
400 Bad Request bad input parameter None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden - you cannot access the resource you are attempting to access. None
429 Too Many Requests Too Many Requests - More requests have been made in the last minute than your account is permitted None
500 Internal Server Error Unspecifed processing error None

Response Schema

Enumerated Values

Property Value
gender Female
gender Male
gender Other

Retrieves list of workers by location for an organization

Code samples

var client = new RestClient("https://api.delaget.com/api/v1/organizations/string/workers");
var request = new RestRequest(Method.GET);
request.AddHeader("apikey", "API_KEY");
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);
curl --request GET \
  --url https://api.delaget.com/api/v1/organizations/string/workers \
  --header 'accept: application/json' \
  --header 'apikey: API_KEY'
HttpResponse response = Unirest.get("https://api.delaget.com/api/v1/organizations/string/workers")
  .header("accept", "application/json")
  .header("apikey", "API_KEY")
  .asString();
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.delaget.com/api/v1/organizations/string/workers");
xhr.setRequestHeader("accept", "application/json");
xhr.setRequestHeader("apikey", "API_KEY");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.delaget.com")

headers = {
    'accept': "application/json",
    'apikey': "API_KEY"
    }

conn.request("GET", "/api/v1/organizations/string/workers", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
require 'uri'
require 'net/http'

url = URI("https://api.delaget.com/api/v1/organizations/string/workers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["apikey"] = 'API_KEY'

response = http.request(request)
puts response.read_body

GET /organizations/{organization_code}/workers

Retrieves details about one organization's workers.

Parameters

Name In Type Required Description
organization_code path string true identifier for the organization

Example responses

Results matching the input parameters, response envelope contains a list of worker objects.

{
  "data": [
    {
      "location_id": 217381,
      "location_number": "901398",
      "organization_location_identifier": "901398",
      "name": "MAIN STREET",
      "open_date": "1980-01-01",
      "address": {
        "street": "1672 MAIN ST.",
        "city": "ST. PAUL",
        "state": "MN",
        "zip": "99999"
      },
      "workers": [
        {
          "id": 955774,
          "first_name": "JOHN",
          "last_name": "CAKE",
          "hire_date": "2004-06-01",
          "term_date": "2004-06-01"
        },
        {
          "id": 955775,
          "first_name": "JANE",
          "last_name": "JACKSON",
          "middle_initial": "R",
          "hire_date": "2003-04-01",
          "birth_date": "1985-01-14",
          "term_code": "VT16",
          "term_date": "2006-05-18",
          "gender": "Male",
          "address": {
            "street": "115 BIRK AVE W # 13",
            "city": "ST PAUL",
            "state": "MN",
            "zip": "99999",
            "zip_plus_four": "5427"
          }
        },
        {
          "id": 955776,
          "first_name": "KATHY",
          "last_name": "JAMES",
          "middle_initial": "E",
          "hire_date": "2005-12-13",
          "term_date": "2006-02-21"
        },
        {
          "id": 955777,
          "first_name": "RAY",
          "last_name": "OLIVE",
          "hire_date": "2002-07-24",
          "birth_date": "1989-04-28",
          "term_date": "2002-09-14",
          "gender": "Male",
          "address": {
            "street": "652 GRAND ST # 1",
            "city": "ST.PAUL",
            "state": "MN",
            "zip": "99999",
            "zip_plus_four": "0000"
          }
        },
        {
          "id": 955778,
          "first_name": "JANET",
          "last_name": "THOME",
          "hire_date": "2013-04-19",
          "birth_date": "1994-05-11",
          "term_code": "VT11",
          "term_date": "2015-02-23",
          "gender": "Male",
          "address": {
            "street": "180 SNELLING AVE W # 999",
            "city": "ST PAUL",
            "state": "MN",
            "zip": "99999",
            "zip_plus_four": "0000"
          }
        },
        {
          "id": 955779,
          "first_name": "LISA",
          "last_name": "BOYD",
          "hire_date": "2001-12-25",
          "term_date": "2003-12-23"
        },
        {
          "id": 955780,
          "first_name": "DEAN",
          "last_name": "MAPLE",
          "middle_initial": "A",
          "hire_date": "2002-06-22",
          "birth_date": "1984-09-18",
          "term_code": "VT24",
          "term_date": "2009-01-04",
          "gender": "Male",
          "address": {
            "street": "1999 MARK AVE # A",
            "city": "ST PAUL",
            "state": "MN",
            "zip": "99999",
            "zip_plus_four": "0000"
          }
        }
      ]
    },
    {
      "location_id": 217391,
      "location_number": "902396",
      "organization_location_identifier": "902396",
      "name": "MOUNT CARMEL",
      "open_date": "1980-01-01",
      "address": {
        "street": "999 HIGHWAY 125",
        "city": "MOUNT CARMEL",
        "state": "MN",
        "zip": "99999"
      },
      "workers": [
        {
          "id": 955510,
          "first_name": "KATHY",
          "last_name": "STEPHENS",
          "middle_initial": "A",
          "hire_date": "2013-12-10",
          "term_code": "Borrow",
          "term_date": "2014-05-13"
        },
        {
          "id": 955520,
          "first_name": "CHRIS",
          "last_name": "RIGHT",
          "hire_date": "2011-11-29",
          "term_date": "2011-11-29"
        },
        {
          "id": 955592,
          "first_name": "JACKSON",
          "last_name": "CRAIG",
          "middle_initial": "R",
          "hire_date": "2013-12-10",
          "term_code": "Borrow",
          "term_date": "2014-02-18"
        }
      ]
    }
  ],
  "data_type": "location[]",
  "available_requests": 199
}

Responses

Status Meaning Description Schema
200 OK Results matching the input parameters, response envelope contains a list of worker objects. Inline
400 Bad Request bad input parameter None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden - you cannot access the resource you are attempting to access. None
429 Too Many Requests Too Many Requests - More requests have been made in the last minute than your account is permitted None
500 Internal Server Error Unspecifed processing error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» data object false none none
» paging paging false none none
»» cursor cursors false none none
»»» after string false none This cursor points to the end of the page that has been returned
»» next string false none The endpoint next results based on the cursor
» available_requests number false none The number of requests the caller can make before getting a HTTP 429 (Too Many Requests) response

Location

Retrieves a labor data on a business day

Code samples

var client = new RestClient("https://api.delaget.com/api/v1/organizations/string/locations/0/time_cards?date=2022-02-04");
var request = new RestRequest(Method.GET);
request.AddHeader("apikey", "API_KEY");
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);
curl --request GET \
  --url 'https://api.delaget.com/api/v1/organizations/string/locations/0/time_cards?date=2022-02-04' \
  --header 'accept: application/json' \
  --header 'apikey: API_KEY'
HttpResponse response = Unirest.get("https://api.delaget.com/api/v1/organizations/string/locations/0/time_cards?date=2022-02-04")
  .header("accept", "application/json")
  .header("apikey", "API_KEY")
  .asString();
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.delaget.com/api/v1/organizations/string/locations/0/time_cards?date=2022-02-04");
xhr.setRequestHeader("accept", "application/json");
xhr.setRequestHeader("apikey", "API_KEY");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.delaget.com")

headers = {
    'accept': "application/json",
    'apikey': "API_KEY"
    }

conn.request("GET", "/api/v1/organizations/string/locations/0/time_cards?date=2022-02-04", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
require 'uri'
require 'net/http'

url = URI("https://api.delaget.com/api/v1/organizations/string/locations/0/time_cards?date=2022-02-04")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["apikey"] = 'API_KEY'

response = http.request(request)
puts response.read_body

GET /organizations/{organization_code}/locations/{location_id}/time_cards

By passing in the appropriate options you can retrieve time punches for a location on a given day.

Parameters

Name In Type Required Description
organization_code path string true identifier for the organization
location_id path integer(int32) true Required location identifier
date query string(date) true Required date of time punches
after query string false return records after to this cursor
limit query integer(int32) false maximum number of records to return

Example responses

Results matching the input parameters, response envelope contains an array with time_card objects.

{
  "data": {},
  "paging": {
    "cursor": {
      "after": "string"
    },
    "next": "string"
  },
  "available_requests": 0
}

Responses

Status Meaning Description Schema
200 OK Results matching the input parameters, response envelope contains an array with time_card objects. Inline
400 Bad Request bad input parameter None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden - you cannot access the resource you are attempting to access. None
429 Too Many Requests Too Many Requests - More requests have been made in the last minute than your account is permitted None
500 Internal Server Error Unspecifed processing error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» data object false none none
» paging paging false none none
»» cursor cursors false none none
»»» after string false none This cursor points to the end of the page that has been returned
»» next string false none The endpoint next results based on the cursor
» available_requests number false none The number of requests the caller can make before getting a HTTP 429 (Too Many Requests) response

Retrieves location summary information on a business day

Code samples

var client = new RestClient("https://api.delaget.com/api/v1/organizations/string/locations/0/summary?date=2022-02-04");
var request = new RestRequest(Method.GET);
request.AddHeader("apikey", "API_KEY");
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);
curl --request GET \
  --url 'https://api.delaget.com/api/v1/organizations/string/locations/0/summary?date=2022-02-04' \
  --header 'accept: application/json' \
  --header 'apikey: API_KEY'
HttpResponse response = Unirest.get("https://api.delaget.com/api/v1/organizations/string/locations/0/summary?date=2022-02-04")
  .header("accept", "application/json")
  .header("apikey", "API_KEY")
  .asString();
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.delaget.com/api/v1/organizations/string/locations/0/summary?date=2022-02-04");
xhr.setRequestHeader("accept", "application/json");
xhr.setRequestHeader("apikey", "API_KEY");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.delaget.com")

headers = {
    'accept': "application/json",
    'apikey': "API_KEY"
    }

conn.request("GET", "/api/v1/organizations/string/locations/0/summary?date=2022-02-04", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
require 'uri'
require 'net/http'

url = URI("https://api.delaget.com/api/v1/organizations/string/locations/0/summary?date=2022-02-04")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["apikey"] = 'API_KEY'

response = http.request(request)
puts response.read_body

GET /organizations/{organization_code}/locations/{location_id}/summary

By passing in the appropriate options you can retrieve summary information (including ledger account summary data) for a location on a given day.

Parameters

Name In Type Required Description
organization_code path string true identifier for the organization
location_id path integer(int32) true Required location identifier
date query string(date) true Required date of summary data

Example responses

Results matching the input parameters, response envelope contains an array with summary objects.

{
  "data": {},
  "paging": {
    "cursor": {
      "after": "string"
    },
    "next": "string"
  },
  "available_requests": 0
}

Responses

Status Meaning Description Schema
200 OK Results matching the input parameters, response envelope contains an array with summary objects. Inline
400 Bad Request bad input parameter None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden - you cannot access the resource you are attempting to access. None
429 Too Many Requests Too Many Requests - More requests have been made in the last minute than your account is permitted None
500 Internal Server Error Unspecifed processing error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» data object false none none
» paging paging false none none
»» cursor cursors false none none
»»» after string false none This cursor points to the end of the page that has been returned
»» next string false none The endpoint next results based on the cursor
» available_requests number false none The number of requests the caller can make before getting a HTTP 429 (Too Many Requests) response

Retrieves a list of orders for a business day

Code samples

var client = new RestClient("https://api.delaget.com/api/v1/organizations/string/locations/string/retail_transactions?date=2022-02-04");
var request = new RestRequest(Method.GET);
request.AddHeader("apikey", "API_KEY");
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);
curl --request GET \
  --url 'https://api.delaget.com/api/v1/organizations/string/locations/string/retail_transactions?date=2022-02-04' \
  --header 'accept: application/json' \
  --header 'apikey: API_KEY'
HttpResponse response = Unirest.get("https://api.delaget.com/api/v1/organizations/string/locations/string/retail_transactions?date=2022-02-04")
  .header("accept", "application/json")
  .header("apikey", "API_KEY")
  .asString();
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.delaget.com/api/v1/organizations/string/locations/string/retail_transactions?date=2022-02-04");
xhr.setRequestHeader("accept", "application/json");
xhr.setRequestHeader("apikey", "API_KEY");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.delaget.com")

headers = {
    'accept': "application/json",
    'apikey': "API_KEY"
    }

conn.request("GET", "/api/v1/organizations/string/locations/string/retail_transactions?date=2022-02-04", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
require 'uri'
require 'net/http'

url = URI("https://api.delaget.com/api/v1/organizations/string/locations/string/retail_transactions?date=2022-02-04")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["apikey"] = 'API_KEY'

response = http.request(request)
puts response.read_body

GET /organizations/{organization_code}/locations/{location_id}/retail_transactions

By passing in the appropriate options you can retrieve orders for a location on a given day.

Parameters

Name In Type Required Description
organization_code path string true identifier for the organization
location_id path string true The location identifier for the location you would like to retrieve transactions for.
date query string(date) true Business date of orders
after query string false return records after to this cursor
limit query integer(int32) false maximum number of records to return

Example responses

Results matching the input parameters, response envelope contains an array with retail_transaction objects.

{
  "data": {},
  "paging": {
    "cursor": {
      "after": "string"
    },
    "next": "string"
  },
  "available_requests": 0
}

Responses

Status Meaning Description Schema
200 OK Results matching the input parameters, response envelope contains an array with retail_transaction objects. Inline
400 Bad Request bad input parameter None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden - you cannot access the resource you are attempting to access. None
429 Too Many Requests Too Many Requests - More requests have been made in the last minute than your account is permitted None
500 Internal Server Error Unspecifed processing error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» data object false none none
» paging paging false none none
»» cursor cursors false none none
»»» after string false none This cursor points to the end of the page that has been returned
»» next string false none The endpoint next results based on the cursor
» available_requests number false none The number of requests the caller can make before getting a HTTP 429 (Too Many Requests) response

Schemas

response_envelope

{
  "data": {},
  "paging": {
    "cursor": {
      "after": "string"
    },
    "next": "string"
  },
  "available_requests": 0
}

Properties

Name Type Required Restrictions Description
data object false none none
paging paging false none none
available_requests number false none The number of requests the caller can make before getting a HTTP 429 (Too Many Requests) response

paging

{
  "cursor": {
    "after": "string"
  },
  "next": "string"
}

Properties

Name Type Required Restrictions Description
cursor cursors false none none
next string false none The endpoint next results based on the cursor

cursors

{
  "after": "string"
}

Properties

Name Type Required Restrictions Description
after string false none This cursor points to the end of the page that has been returned

organization

{
  "code": "YCI",
  "name": "Your restaurants incorporated",
  "locations": [
    {
      "location_id": 1234,
      "location_number": 12345,
      "organization_location_identifier": "012345 - Rice Street",
      "name": "Lake Street",
      "open_date": "2017-02-01",
      "close_date": "2018-02-01",
      "address": {
        "street": "100 Main Street",
        "suite": "400 east",
        "city": "Anytown",
        "county": "County",
        "state": "MN",
        "zip": "01234",
        "zip_plus_four": "1234"
      },
      "workers": [
        {
          "id": "1234wsa",
          "first_name": "John",
          "last_name": "Doe",
          "middle_initial": "M",
          "phone": "4088675309",
          "alternative_phone": "string",
          "email": "user@example.com",
          "hire_date": "2017-02-01",
          "birth_date": "2000-02-01",
          "term_code": "string",
          "term_date": "2017-02-01",
          "gender": "Female",
          "address": {
            "street": "100 Main Street",
            "suite": "400 east",
            "city": "Anytown",
            "county": "County",
            "state": "MN",
            "zip": "01234",
            "zip_plus_four": "1234"
          },
          "client_worker_identification": {
            "company_code": "string",
            "identifier": "string"
          }
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
code string false none Unique code which identifies this organization.
name string false none The name of the organization.
locations [location] false none An array of location objects contain the retail locations for the organization.

money

{
  "amount": "5.35",
  "currency_code": "USD"
}

Properties

Name Type Required Restrictions Description
amount number false none none
currency_code string false none ISO 4217 Currency Code

location

{
  "location_id": 1234,
  "location_number": 12345,
  "organization_location_identifier": "012345 - Rice Street",
  "name": "Lake Street",
  "open_date": "2017-02-01",
  "close_date": "2018-02-01",
  "address": {
    "street": "100 Main Street",
    "suite": "400 east",
    "city": "Anytown",
    "county": "County",
    "state": "MN",
    "zip": "01234",
    "zip_plus_four": "1234"
  },
  "workers": [
    {
      "id": "1234wsa",
      "first_name": "John",
      "last_name": "Doe",
      "middle_initial": "M",
      "phone": "4088675309",
      "alternative_phone": "string",
      "email": "user@example.com",
      "hire_date": "2017-02-01",
      "birth_date": "2000-02-01",
      "term_code": "string",
      "term_date": "2017-02-01",
      "gender": "Female",
      "address": {
        "street": "100 Main Street",
        "suite": "400 east",
        "city": "Anytown",
        "county": "County",
        "state": "MN",
        "zip": "01234",
        "zip_plus_four": "1234"
      },
      "client_worker_identification": {
        "company_code": "string",
        "identifier": "string"
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
location_id number false none Unique identifier which identifies this location across Delaget.
location_number string false none Number identifying this location, unique within a organization.
organization_location_identifier string false none An organizational specific name given to the location, typically used for UI purposes.
name string false none Organization given name for the location
open_date string(date) false none The date the store was opened.
close_date string(date) false none The date the store closed. If this value is populated the store is not currently open.
address address false none none
workers [worker] false none none

location_summary

{
  "paid_in_amount": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "paid_out_amount": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "net_sales": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "gross_sales": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "ledger_account_summaries": [
    {
      "account_number": "string",
      "account_name": "string",
      "amount": 0,
      "types": [
        {
          "type": "Allowances",
          "factor": -1
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
paid_in_amount money false none none
paid_out_amount money false none none
net_sales money false none none
gross_sales money false none none
ledger_account_summaries [ledger_account_summary] false none [A financial account for a location on a given day. Note that multiple accounts may have the same type. For example two accounts may be related to net sales.]

ledger_account_summary

{
  "account_number": "string",
  "account_name": "string",
  "amount": 0,
  "types": [
    {
      "type": "Allowances",
      "factor": -1
    }
  ]
}

A financial account for a location on a given day. Note that multiple accounts may have the same type. For example two accounts may be related to net sales.

Properties

Name Type Required Restrictions Description
account_number string true none none
account_name string true none none
amount number true none none
types [account_type] false none [Describes the type of financal account.]

account_type

{
  "type": "Allowances",
  "factor": -1
}

Describes the type of financal account.

Properties

Name Type Required Restrictions Description
type string false none none
factor integer false none Denotes how this account value should be applied to the total. Factor can be multipled by the amount to either subtract or add the total calcuation of the account type.

Enumerated Values

Property Value
type Allowances
type Charity
type Deletions
type Deposits
type Discounts
type EmployeeMeals
type ExemptSales
type GiftCertificateSales
type GrossSales
type MissingFunds
type NetSales
type Overrings
type PaidIn
type PaidOut
type PremiumSales
type Promos
type Refunds
type SalesTax
type TaxableSales
type Vouchers

time_card

{
  "id": 0,
  "business_day": "2017-02-01",
  "clocked_in": "2019-01-01T17:30:28",
  "clocked_out": "2019-01-01T20:30:00",
  "job_code": {
    "code": "string",
    "description": "string"
  },
  "pay_rate": {
    "rate": {
      "amount": "5.35",
      "currency_code": "USD"
    },
    "effective_date": "2017-02-01",
    "expiration_date": "2018-02-01"
  },
  "regular_hours": "9.00",
  "overtime_hours": "9.00",
  "doubletime_hours": "1",
  "charged_tips": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "sales": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "tips": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "worker": {
    "id": "1234wsa",
    "first_name": "John",
    "last_name": "Doe",
    "middle_initial": "M",
    "phone": "4088675309",
    "alternative_phone": "string",
    "email": "user@example.com",
    "hire_date": "2017-02-01",
    "birth_date": "2000-02-01",
    "term_code": "string",
    "term_date": "2017-02-01",
    "gender": "Female",
    "address": {
      "street": "100 Main Street",
      "suite": "400 east",
      "city": "Anytown",
      "county": "County",
      "state": "MN",
      "zip": "01234",
      "zip_plus_four": "1234"
    },
    "client_worker_identification": {
      "company_code": "string",
      "identifier": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
id number true none none
business_day string(date) false none none
clocked_in string(date-time) true none none
clocked_out string(date-time) true none none
job_code job_code false none none
pay_rate pay_rate false none none
regular_hours number false none none
overtime_hours number false none none
doubletime_hours number false none none
charged_tips money false none none
sales money false none none
tips money false none none
worker worker true none none

job_code

{
  "code": "string",
  "description": "string"
}

Properties

Name Type Required Restrictions Description
code string false none none
description string false none none

pay_rate

{
  "rate": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "effective_date": "2017-02-01",
  "expiration_date": "2018-02-01"
}

Properties

Name Type Required Restrictions Description
rate money false none none
effective_date string(date) false none none
expiration_date string(date) false none none

worker

{
  "id": "1234wsa",
  "first_name": "John",
  "last_name": "Doe",
  "middle_initial": "M",
  "phone": "4088675309",
  "alternative_phone": "string",
  "email": "user@example.com",
  "hire_date": "2017-02-01",
  "birth_date": "2000-02-01",
  "term_code": "string",
  "term_date": "2017-02-01",
  "gender": "Female",
  "address": {
    "street": "100 Main Street",
    "suite": "400 east",
    "city": "Anytown",
    "county": "County",
    "state": "MN",
    "zip": "01234",
    "zip_plus_four": "1234"
  },
  "client_worker_identification": {
    "company_code": "string",
    "identifier": "string"
  }
}

Properties

Name Type Required Restrictions Description
id string true none A identifier unique to the organization for the employee
first_name string false none none
last_name string false none none
middle_initial string false none none
phone string false none none
alternative_phone string false none none
email string(email) false none none
hire_date string(date) false none none
birth_date string(date) false none none
term_code string false none The organization specific reason a worker was terminated.
term_date string(date) false none none
gender string false none none
address address false none none
client_worker_identification client_worker_identification false none Provides a shared key between the client and the worker, often used for a payroll identifier.

Enumerated Values

Property Value
gender Female
gender Male
gender Other

retail_transactions

[
  {
    "id": "1234abc",
    "identifier": "string",
    "business_day": "2017-02-01",
    "check_number": "1234abc",
    "register_number": "1234abc",
    "status": "Finished",
    "is_split_transfer": false,
    "order_entry_employee": {
      "id": "1234wsa",
      "first_name": "John",
      "last_name": "Doe",
      "middle_initial": "M",
      "phone": "4088675309",
      "alternative_phone": "string",
      "email": "user@example.com",
      "hire_date": "2017-02-01",
      "birth_date": "2000-02-01",
      "term_code": "string",
      "term_date": "2017-02-01",
      "gender": "Female",
      "address": {
        "street": "100 Main Street",
        "suite": "400 east",
        "city": "Anytown",
        "county": "County",
        "state": "MN",
        "zip": "01234",
        "zip_plus_four": "1234"
      },
      "client_worker_identification": {
        "company_code": "string",
        "identifier": "string"
      }
    },
    "cashier": {
      "id": "1234wsa",
      "first_name": "John",
      "last_name": "Doe",
      "middle_initial": "M",
      "phone": "4088675309",
      "alternative_phone": "string",
      "email": "user@example.com",
      "hire_date": "2017-02-01",
      "birth_date": "2000-02-01",
      "term_code": "string",
      "term_date": "2017-02-01",
      "gender": "Female",
      "address": {
        "street": "100 Main Street",
        "suite": "400 east",
        "city": "Anytown",
        "county": "County",
        "state": "MN",
        "zip": "01234",
        "zip_plus_four": "1234"
      },
      "client_worker_identification": {
        "company_code": "string",
        "identifier": "string"
      }
    },
    "total_amount": {
      "amount": "5.35",
      "currency_code": "USD"
    },
    "tax_amount": {
      "amount": "5.35",
      "currency_code": "USD"
    },
    "discount_amount": {
      "amount": "5.35",
      "currency_code": "USD"
    },
    "open_time": "2019-01-01T20:30:00",
    "closed_time": "2019-01-01T20:30:00",
    "channel": {
      "name": "Delivery Service Front Counter",
      "description": "string",
      "group": "DeliveryService"
    },
    "destination": {
      "destination_name": "drive thru",
      "destination_description": "string",
      "destination_group": "drive_thru"
    },
    "tender": [
      {
        "type": "Cash, Coupon, Check, CreditDebit, CustomerAccount, GiftCard, GiftCertificate, Loyalty, Mobile, OnlinePayment, Voucher, Other",
        "subtender_type": "Amex, DinersClub, DiscoverCard, GoogleWallet, MasterCard, PayPal, Visa, ApplePay",
        "amount": {
          "amount": "5.35",
          "currency_code": "USD"
        },
        "change": {
          "amount": "5.35",
          "currency_code": "USD"
        },
        "amount_applied_to_bill": {
          "amount": "5.35",
          "currency_code": "USD"
        },
        "gift_card_number": "string",
        "account_number_last_four": "string",
        "tip_amount": {
          "amount": "5.35",
          "currency_code": "USD"
        }
      }
    ],
    "line_items": [
      {
        "id": 0,
        "price_modifiers": [
          {
            "key": "string",
            "group_type": "GeneralDiscount",
            "amount": {
              "amount": "5.35",
              "currency_code": "USD"
            },
            "quantity": 0,
            "approval": {
              "approver": {
                "id": "1234wsa",
                "first_name": "John",
                "last_name": "Doe",
                "middle_initial": "M",
                "phone": "4088675309",
                "alternative_phone": "string",
                "email": "user@example.com",
                "hire_date": "2017-02-01",
                "birth_date": "2000-02-01",
                "term_code": "string",
                "term_date": "2017-02-01",
                "gender": "Female",
                "address": {
                  "street": "100 Main Street",
                  "suite": "400 east",
                  "city": "Anytown",
                  "county": "County",
                  "state": "MN",
                  "zip": "01234",
                  "zip_plus_four": "1234"
                },
                "client_worker_identification": {
                  "company_code": "string",
                  "identifier": "string"
                }
              }
            },
            "entered_by": {
              "id": "1234wsa",
              "first_name": "John",
              "last_name": "Doe",
              "middle_initial": "M",
              "phone": "4088675309",
              "alternative_phone": "string",
              "email": "user@example.com",
              "hire_date": "2017-02-01",
              "birth_date": "2000-02-01",
              "term_code": "string",
              "term_date": "2017-02-01",
              "gender": "Female",
              "address": {
                "street": "100 Main Street",
                "suite": "400 east",
                "city": "Anytown",
                "county": "County",
                "state": "MN",
                "zip": "01234",
                "zip_plus_four": "1234"
              },
              "client_worker_identification": {
                "company_code": "string",
                "identifier": "string"
              }
            },
            "description": "string"
          }
        ],
        "type": "Sale",
        "split_transfer": {
          "type": "Split",
          "direction": "From",
          "transaction_id": "string"
        },
        "item": {
          "key": "string",
          "type": "Stock",
          "name": "string",
          "product_type_id": "string",
          "product_type_name": "string",
          "is_part_of": 0,
          "action_code": "Add",
          "is_deferred_sale": true
        },
        "quantity": 0,
        "actual_price": {
          "amount": "5.35",
          "currency_code": "USD"
        },
        "regular_price": {
          "amount": "5.35",
          "currency_code": "USD"
        },
        "applied_time": "2019-01-01T20:30:00",
        "is_void": true,
        "void_approval": {
          "approver": {
            "id": "1234wsa",
            "first_name": "John",
            "last_name": "Doe",
            "middle_initial": "M",
            "phone": "4088675309",
            "alternative_phone": "string",
            "email": "user@example.com",
            "hire_date": "2017-02-01",
            "birth_date": "2000-02-01",
            "term_code": "string",
            "term_date": "2017-02-01",
            "gender": "Female",
            "address": {
              "street": "100 Main Street",
              "suite": "400 east",
              "city": "Anytown",
              "county": "County",
              "state": "MN",
              "zip": "01234",
              "zip_plus_four": "1234"
            },
            "client_worker_identification": {
              "company_code": "string",
              "identifier": "string"
            }
          }
        },
        "is_cancel": true,
        "is_delete": true,
        "reason": "string"
      }
    ]
  }
]

Properties

Name Type Required Restrictions Description
anonymous [retail_transaction] false none [Field notes: - total_amount: Sum of retail_transaction_item.quantity * retail_transaction_item.actual_price and tax_amount - discount_amount: Sum of transaction discounts and transaction item discounts ]

address

{
  "street": "100 Main Street",
  "suite": "400 east",
  "city": "Anytown",
  "county": "County",
  "state": "MN",
  "zip": "01234",
  "zip_plus_four": "1234"
}

Properties

Name Type Required Restrictions Description
street string false none none
suite string false none none
city string false none none
county string false none none
state string false none none
zip string false none none
zip_plus_four string false none none

retail_transaction

{
  "id": "1234abc",
  "identifier": "string",
  "business_day": "2017-02-01",
  "check_number": "1234abc",
  "register_number": "1234abc",
  "status": "Finished",
  "is_split_transfer": false,
  "order_entry_employee": {
    "id": "1234wsa",
    "first_name": "John",
    "last_name": "Doe",
    "middle_initial": "M",
    "phone": "4088675309",
    "alternative_phone": "string",
    "email": "user@example.com",
    "hire_date": "2017-02-01",
    "birth_date": "2000-02-01",
    "term_code": "string",
    "term_date": "2017-02-01",
    "gender": "Female",
    "address": {
      "street": "100 Main Street",
      "suite": "400 east",
      "city": "Anytown",
      "county": "County",
      "state": "MN",
      "zip": "01234",
      "zip_plus_four": "1234"
    },
    "client_worker_identification": {
      "company_code": "string",
      "identifier": "string"
    }
  },
  "cashier": {
    "id": "1234wsa",
    "first_name": "John",
    "last_name": "Doe",
    "middle_initial": "M",
    "phone": "4088675309",
    "alternative_phone": "string",
    "email": "user@example.com",
    "hire_date": "2017-02-01",
    "birth_date": "2000-02-01",
    "term_code": "string",
    "term_date": "2017-02-01",
    "gender": "Female",
    "address": {
      "street": "100 Main Street",
      "suite": "400 east",
      "city": "Anytown",
      "county": "County",
      "state": "MN",
      "zip": "01234",
      "zip_plus_four": "1234"
    },
    "client_worker_identification": {
      "company_code": "string",
      "identifier": "string"
    }
  },
  "total_amount": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "tax_amount": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "discount_amount": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "open_time": "2019-01-01T20:30:00",
  "closed_time": "2019-01-01T20:30:00",
  "channel": {
    "name": "Delivery Service Front Counter",
    "description": "string",
    "group": "DeliveryService"
  },
  "destination": {
    "destination_name": "drive thru",
    "destination_description": "string",
    "destination_group": "drive_thru"
  },
  "tender": [
    {
      "type": "Cash, Coupon, Check, CreditDebit, CustomerAccount, GiftCard, GiftCertificate, Loyalty, Mobile, OnlinePayment, Voucher, Other",
      "subtender_type": "Amex, DinersClub, DiscoverCard, GoogleWallet, MasterCard, PayPal, Visa, ApplePay",
      "amount": {
        "amount": "5.35",
        "currency_code": "USD"
      },
      "change": {
        "amount": "5.35",
        "currency_code": "USD"
      },
      "amount_applied_to_bill": {
        "amount": "5.35",
        "currency_code": "USD"
      },
      "gift_card_number": "string",
      "account_number_last_four": "string",
      "tip_amount": {
        "amount": "5.35",
        "currency_code": "USD"
      }
    }
  ],
  "line_items": [
    {
      "id": 0,
      "price_modifiers": [
        {
          "key": "string",
          "group_type": "GeneralDiscount",
          "amount": {
            "amount": "5.35",
            "currency_code": "USD"
          },
          "quantity": 0,
          "approval": {
            "approver": {
              "id": "1234wsa",
              "first_name": "John",
              "last_name": "Doe",
              "middle_initial": "M",
              "phone": "4088675309",
              "alternative_phone": "string",
              "email": "user@example.com",
              "hire_date": "2017-02-01",
              "birth_date": "2000-02-01",
              "term_code": "string",
              "term_date": "2017-02-01",
              "gender": "Female",
              "address": {
                "street": "100 Main Street",
                "suite": "400 east",
                "city": "Anytown",
                "county": "County",
                "state": "MN",
                "zip": "01234",
                "zip_plus_four": "1234"
              },
              "client_worker_identification": {
                "company_code": "string",
                "identifier": "string"
              }
            }
          },
          "entered_by": {
            "id": "1234wsa",
            "first_name": "John",
            "last_name": "Doe",
            "middle_initial": "M",
            "phone": "4088675309",
            "alternative_phone": "string",
            "email": "user@example.com",
            "hire_date": "2017-02-01",
            "birth_date": "2000-02-01",
            "term_code": "string",
            "term_date": "2017-02-01",
            "gender": "Female",
            "address": {
              "street": "100 Main Street",
              "suite": "400 east",
              "city": "Anytown",
              "county": "County",
              "state": "MN",
              "zip": "01234",
              "zip_plus_four": "1234"
            },
            "client_worker_identification": {
              "company_code": "string",
              "identifier": "string"
            }
          },
          "description": "string"
        }
      ],
      "type": "Sale",
      "split_transfer": {
        "type": "Split",
        "direction": "From",
        "transaction_id": "string"
      },
      "item": {
        "key": "string",
        "type": "Stock",
        "name": "string",
        "product_type_id": "string",
        "product_type_name": "string",
        "is_part_of": 0,
        "action_code": "Add",
        "is_deferred_sale": true
      },
      "quantity": 0,
      "actual_price": {
        "amount": "5.35",
        "currency_code": "USD"
      },
      "regular_price": {
        "amount": "5.35",
        "currency_code": "USD"
      },
      "applied_time": "2019-01-01T20:30:00",
      "is_void": true,
      "void_approval": {
        "approver": {
          "id": "1234wsa",
          "first_name": "John",
          "last_name": "Doe",
          "middle_initial": "M",
          "phone": "4088675309",
          "alternative_phone": "string",
          "email": "user@example.com",
          "hire_date": "2017-02-01",
          "birth_date": "2000-02-01",
          "term_code": "string",
          "term_date": "2017-02-01",
          "gender": "Female",
          "address": {
            "street": "100 Main Street",
            "suite": "400 east",
            "city": "Anytown",
            "county": "County",
            "state": "MN",
            "zip": "01234",
            "zip_plus_four": "1234"
          },
          "client_worker_identification": {
            "company_code": "string",
            "identifier": "string"
          }
        }
      },
      "is_cancel": true,
      "is_delete": true,
      "reason": "string"
    }
  ]
}

*Field notes:

Properties

Name Type Required Restrictions Description
id string true none none
identifier string false none unique identifer for this transaction
business_day string(date) false none none
check_number string false none none
register_number string false none none
status string true none Enumerated type identifies the status of this transaction. - Canceled - designates entire transaction that was reversed PRIOR to the tender of a transaction. - PostVoided - A non sales transaction that cancels a prior transaction during the same day. (Refund at the same day) - Voided - Designates entire transaction that was reversed as part of a tendered transaction, that is, it is being voided in its entirety. - Returned - Designates this transaction was returned. (Refund after the books are reconciled at the end of day processing) - Finished - Designates transaction was completed, tendered, delivered, and without any cancel and void etc. - Transferred - Designates items on the transaction have been transfereed to other tickets
is_split_transfer boolean false none Identifies the transaction as having split or transfer line_items.
order_entry_employee worker false none none
cashier worker false none none
total_amount money false none none
tax_amount money false none none
discount_amount money false none none
open_time string(date-time) false none none
closed_time string(date-time) false none none
channel channel false none none
destination destination false none none
tender [tender] false none [Field notes: - amount: The actual amount of currency presented (tax and tips included) ]
line_items [retail_transaction_item] false none [A line item in a transaction, if the price modifier item is populated the price modifier, with no other data it is at the general retail_transaction level.]

Enumerated Values

Property Value
status Canceled
status PostVoided
status Voided
status Returned
status Finished
status Transferred

retail_transaction_item

{
  "id": 0,
  "price_modifiers": [
    {
      "key": "string",
      "group_type": "GeneralDiscount",
      "amount": {
        "amount": "5.35",
        "currency_code": "USD"
      },
      "quantity": 0,
      "approval": {
        "approver": {
          "id": "1234wsa",
          "first_name": "John",
          "last_name": "Doe",
          "middle_initial": "M",
          "phone": "4088675309",
          "alternative_phone": "string",
          "email": "user@example.com",
          "hire_date": "2017-02-01",
          "birth_date": "2000-02-01",
          "term_code": "string",
          "term_date": "2017-02-01",
          "gender": "Female",
          "address": {
            "street": "100 Main Street",
            "suite": "400 east",
            "city": "Anytown",
            "county": "County",
            "state": "MN",
            "zip": "01234",
            "zip_plus_four": "1234"
          },
          "client_worker_identification": {
            "company_code": "string",
            "identifier": "string"
          }
        }
      },
      "entered_by": {
        "id": "1234wsa",
        "first_name": "John",
        "last_name": "Doe",
        "middle_initial": "M",
        "phone": "4088675309",
        "alternative_phone": "string",
        "email": "user@example.com",
        "hire_date": "2017-02-01",
        "birth_date": "2000-02-01",
        "term_code": "string",
        "term_date": "2017-02-01",
        "gender": "Female",
        "address": {
          "street": "100 Main Street",
          "suite": "400 east",
          "city": "Anytown",
          "county": "County",
          "state": "MN",
          "zip": "01234",
          "zip_plus_four": "1234"
        },
        "client_worker_identification": {
          "company_code": "string",
          "identifier": "string"
        }
      },
      "description": "string"
    }
  ],
  "type": "Sale",
  "split_transfer": {
    "type": "Split",
    "direction": "From",
    "transaction_id": "string"
  },
  "item": {
    "key": "string",
    "type": "Stock",
    "name": "string",
    "product_type_id": "string",
    "product_type_name": "string",
    "is_part_of": 0,
    "action_code": "Add",
    "is_deferred_sale": true
  },
  "quantity": 0,
  "actual_price": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "regular_price": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "applied_time": "2019-01-01T20:30:00",
  "is_void": true,
  "void_approval": {
    "approver": {
      "id": "1234wsa",
      "first_name": "John",
      "last_name": "Doe",
      "middle_initial": "M",
      "phone": "4088675309",
      "alternative_phone": "string",
      "email": "user@example.com",
      "hire_date": "2017-02-01",
      "birth_date": "2000-02-01",
      "term_code": "string",
      "term_date": "2017-02-01",
      "gender": "Female",
      "address": {
        "street": "100 Main Street",
        "suite": "400 east",
        "city": "Anytown",
        "county": "County",
        "state": "MN",
        "zip": "01234",
        "zip_plus_four": "1234"
      },
      "client_worker_identification": {
        "company_code": "string",
        "identifier": "string"
      }
    }
  },
  "is_cancel": true,
  "is_delete": true,
  "reason": "string"
}

A line item in a transaction, if the price modifier item is populated the price modifier, with no other data it is at the general retail_transaction level.

Properties

Name Type Required Restrictions Description
id number true none none
price_modifiers [price_modifier_item] false none none
type string false none none
split_transfer split_transfer_item false none Provides information about a split or transferred item.
item sales_item false none Details about a item sold as part of a transaction
quantity number true none none
actual_price money false none none
regular_price money false none none
applied_time string(date-time) false none none
is_void boolean false none Voided is used to designate a transaction line that was reversed after to the tender of a transaction.
void_approval line_item_approval false none none
is_cancel boolean false none Canceled is used to designate a transaction line that was reversed prior to the tender of a transaction.
is_delete boolean false none Delete indicates a line item was sent to the kitchen, the order was recalled and the item was removed from the order.
reason string false none A unique retailer defined reason code for an action that is taken (or not taken) at a Workstation.

Enumerated Values

Property Value
type Sale
type Return
type PriceModification

split_transfer_item

{
  "type": "Split",
  "direction": "From",
  "transaction_id": "string"
}

Provides information about a split or transferred item.

Properties

Name Type Required Restrictions Description
type string false none none
direction string false none none
transaction_id string false none none

Enumerated Values

Property Value
type Split
type Transfer
direction From
direction To

sales_item

{
  "key": "string",
  "type": "Stock",
  "name": "string",
  "product_type_id": "string",
  "product_type_name": "string",
  "is_part_of": 0,
  "action_code": "Add",
  "is_deferred_sale": true
}

Details about a item sold as part of a transaction

Properties

Name Type Required Restrictions Description
key string true none none
type string true none none
name string false none none
product_type_id string false none none
product_type_name string false none none
is_part_of number false none If this item relates to another retail_transaction_item on the ticket (e.g. a combo, this field will be populated with the id of the retail_transaction_item)
action_code string false none Describes the relationship between the parent item (denoted by is_part_of) and the child.
is_deferred_sale boolean false none none

Enumerated Values

Property Value
type Stock
type Service
type Fee
type ItemCollection
action_code Add
action_code AddsTo
action_code IsPartOf
action_code IsRemovedFrom
action_code Only
action_code Replace
action_code Subtract
action_code Other

price_modifier_item

{
  "key": "string",
  "group_type": "GeneralDiscount",
  "amount": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "quantity": 0,
  "approval": {
    "approver": {
      "id": "1234wsa",
      "first_name": "John",
      "last_name": "Doe",
      "middle_initial": "M",
      "phone": "4088675309",
      "alternative_phone": "string",
      "email": "user@example.com",
      "hire_date": "2017-02-01",
      "birth_date": "2000-02-01",
      "term_code": "string",
      "term_date": "2017-02-01",
      "gender": "Female",
      "address": {
        "street": "100 Main Street",
        "suite": "400 east",
        "city": "Anytown",
        "county": "County",
        "state": "MN",
        "zip": "01234",
        "zip_plus_four": "1234"
      },
      "client_worker_identification": {
        "company_code": "string",
        "identifier": "string"
      }
    }
  },
  "entered_by": {
    "id": "1234wsa",
    "first_name": "John",
    "last_name": "Doe",
    "middle_initial": "M",
    "phone": "4088675309",
    "alternative_phone": "string",
    "email": "user@example.com",
    "hire_date": "2017-02-01",
    "birth_date": "2000-02-01",
    "term_code": "string",
    "term_date": "2017-02-01",
    "gender": "Female",
    "address": {
      "street": "100 Main Street",
      "suite": "400 east",
      "city": "Anytown",
      "county": "County",
      "state": "MN",
      "zip": "01234",
      "zip_plus_four": "1234"
    },
    "client_worker_identification": {
      "company_code": "string",
      "identifier": "string"
    }
  },
  "description": "string"
}

Properties

Name Type Required Restrictions Description
key string true none Key which identifies the price modifier
group_type string true none none
amount money true none none
quantity number false none none
approval line_item_approval false none none
entered_by worker false none none
description string false none none

Enumerated Values

Property Value
group_type GeneralDiscount
group_type Coupon
group_type Promotion
group_type GiftVoucher
group_type Rebate
group_type EmployeeMeal
group_type ManagerMeal
group_type SeniorCitizen
group_type Complimentary
group_type CompetitorCoupon

line_item_approval

{
  "approver": {
    "id": "1234wsa",
    "first_name": "John",
    "last_name": "Doe",
    "middle_initial": "M",
    "phone": "4088675309",
    "alternative_phone": "string",
    "email": "user@example.com",
    "hire_date": "2017-02-01",
    "birth_date": "2000-02-01",
    "term_code": "string",
    "term_date": "2017-02-01",
    "gender": "Female",
    "address": {
      "street": "100 Main Street",
      "suite": "400 east",
      "city": "Anytown",
      "county": "County",
      "state": "MN",
      "zip": "01234",
      "zip_plus_four": "1234"
    },
    "client_worker_identification": {
      "company_code": "string",
      "identifier": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
approver worker false none none

tender

{
  "type": "Cash, Coupon, Check, CreditDebit, CustomerAccount, GiftCard, GiftCertificate, Loyalty, Mobile, OnlinePayment, Voucher, Other",
  "subtender_type": "Amex, DinersClub, DiscoverCard, GoogleWallet, MasterCard, PayPal, Visa, ApplePay",
  "amount": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "change": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "amount_applied_to_bill": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "gift_card_number": "string",
  "account_number_last_four": "string",
  "tip_amount": {
    "amount": "5.35",
    "currency_code": "USD"
  }
}

*Field notes:

Properties

Name Type Required Restrictions Description
type string true none none
subtender_type string false none Tender Type Breakdown
amount money true none none
change money false none none
amount_applied_to_bill money false none none
gift_card_number string false none none
account_number_last_four string false none Last 4 digits of the card used
tip_amount money false none none

coupon

{
  "key": "string",
  "name": "string",
  "description": "string",
  "quanity": 0
}

Properties

Name Type Required Restrictions Description
key string true none none
name string false none none
description string false none none
quanity number true none none

channel

{
  "name": "Delivery Service Front Counter",
  "description": "string",
  "group": "DeliveryService"
}

Properties

Name Type Required Restrictions Description
name string false none none
description string false none none
group string false none none

destination

{
  "destination_name": "drive thru",
  "destination_description": "string",
  "destination_group": "drive_thru"
}

Properties

Name Type Required Restrictions Description
destination_name string false none none
destination_description string false none none
destination_group string false none none

client_worker_identification

{
  "company_code": "string",
  "identifier": "string"
}

client_worker_identification

Properties

Name Type Required Restrictions Description
company_code string false none Client based identifier which is a component of an employees identification.
identifier string false none Client provided identifer for a worker.