Cashier

Cashiers are representations of employees who fulfil orders. A cashier will usually have a name and some kind of internal identifier.

The cashier model

The cashier model contains identifying information about the cashier.

Properties

Name
id
Type
string
Description
Unique identifier for the currency.
Name
identifier
Type
string
Description
The internal identifier for this cashier. This is how the cashier would be referenced from inside the point of sale system.
Name
name
Type
string
Description
The cashier's name.
Name
status
Type
string
Description
A string enum for indicating the current status of the currency.

GET/cashiers

Retrieve a list of cashiers

This endpoint allows you to retrieve a paginated list of your cashiers. By default, this will include the 25 most recent objects, starting with the most recent.

Query parameters

Name
limit
Type
integer
Description
The maximum number of entries to include in the response.

Name
page
Type
integer
Description
An offset to determine which groups of results to return.

Name
query
Type
string
Description
A search string which can be used to filter results by various criteria (see below).

Filter parameters

These attributes can be used to filter the result set returned by the API. They are included as a space-delimited string of key:value pairs.

Name
i
Type
string
Description
Identifier of the cashier.

Name
n
Type
string
Description
Name of the cashier.

Name
s
Type
string
Description
Status of the cashier.

Request

GET

/cashiers

curl -G https://api.spoonity.com/cashiers \
  -H "Authorization: Bearer {token}"

Response

{
  "items": [
    {
      "id": "cash_f1b018d318583b2f",
      "identifier": "abc123",
      "name": "John Smith",
      "status": "ACTIVE",
    }
  ],
  "next": "https://api.spoonity.com/cashiers?limit=25&page=2",
  "prev": null
}

GET/cashiers/:id

Retrieve a particular cashier

This endpoint allows you to retrieve a specific cashier by ID.

Path parameters

Name
id
Type
string
Description
The cashier ID.

Request

GET

/cashiers/:id

curl -G https://api.spoonity.com/cashiers/:id \
-H "Authorization: Bearer {token}"

Response

{
  "id": "cash_f1b018d318583b2f",
  "identifier": "abc123",
  "name": "John Smith",
  "status": "ACTIVE",
}

The cashier model

The cashier model contains identifying information about the cashier.

Properties

Name
id
Type
string
Description
Unique identifier for the currency.
Name
identifier
Type
string
Description
The internal identifier for this cashier. This is how the cashier would be referenced from inside the point of sale system.
Name
name
Type
string
Description
The cashier's name.
Name
status
Type
string
Description
A string enum for indicating the current status of the currency.

GET/cashiers

Retrieve a list of cashiers

This endpoint allows you to retrieve a paginated list of your cashiers. By default, this will include the 25 most recent objects, starting with the most recent.

Query parameters

Name
limit
Type
integer
Description
The maximum number of entries to include in the response.

Name
page
Type
integer
Description
An offset to determine which groups of results to return.

Name
query
Type
string
Description
A search string which can be used to filter results by various criteria (see below).

Filter parameters

These attributes can be used to filter the result set returned by the API. They are included as a space-delimited string of key:value pairs.

Name
i
Type
string
Description
Identifier of the cashier.

Name
n
Type
string
Description
Name of the cashier.

Name
s
Type
string
Description
Status of the cashier.

Request

GET

/cashiers

curl -G https://api.spoonity.com/cashiers \
  -H "Authorization: Bearer {token}"

Response

{
  "items": [
    {
      "id": "cash_f1b018d318583b2f",
      "identifier": "abc123",
      "name": "John Smith",
      "status": "ACTIVE",
    }
  ],
  "next": "https://api.spoonity.com/cashiers?limit=25&page=2",
  "prev": null
}

GET/cashiers/:id

Retrieve a particular cashier

This endpoint allows you to retrieve a specific cashier by ID.

Path parameters

Name
id
Type
string
Description
The cashier ID.

Request

GET

/cashiers/:id

curl -G https://api.spoonity.com/cashiers/:id \
-H "Authorization: Bearer {token}"

Response

{
  "id": "cash_f1b018d318583b2f",
  "identifier": "abc123",
  "name": "John Smith",
  "status": "ACTIVE",
}