Skip to main content

Operation Definitions

The External Application operation definitions include the endpoints, data models, and sample code.

Endpoints

GET /health

Summary

Get the health information of the platform and build.

Request Parameters

In

Field Name

Type

Required

Description

header

CONTENT-TYPE

string

Yes

application/json

header

AUTHORIZATION

string

Yes

The integrator token created previously

header

X-COMPANY-ID

string

Yes

The unique identifier (UID) for the company provided by us

Responses

Code

Description

Schema

200

Success

app_info_get_response_1

400

Bad request. For more information, look at the body error.

401

Unauthorized error

403

Forbidden error

404

Not found

422

Unprocessable error

500

Internal server error

GET /info

Summary

Get the application information.

Request Parameters

In

Field Name

Type

Required

Description

header

CONTENT-TYPE

string

Yes

application/json

header

AUTHORIZATION

string

Yes

The integrator token created previously

header

X-COMPANY-ID

string

Yes

The unique identifier (UID) for the company provided by us

Responses

Code

Description

Schema

200

Success

app_info_get_response_2

400

Bad request. For more information, look at the body error.

401

Unauthorized error

403

Forbidden error

404

Not found

422

Unprocessable error

500

Internal server error

POST /boh/auth/pos-login

Summary

Send the point of sale (POS) login information.

Request Parameters

In

Field Name

Type

Required

Description

header

CONTENT-TYPE

string

Yes

application/json

header

AUTHORIZATION

string

Yes

The integrator token created previously

header

X-COMPANY-ID

string

Yes

The unique identifier (UID) for the company provided by us

body

body

boh_post_body_3

Yes

The request information

Responses

Code

Description

Schema

200

Success

400

Bad request. For more information, look at the body error.

401

Unauthorized error

403

Forbidden error

404

Not found

422

Unprocessable error

500

Internal server error

POST /boh/employee/validate

Summary

Send the employee validation with the pos_code.

Request Parameters

In

Field Name

Type

Required

Description

header

CONTENT-TYPE

string

Yes

application/json

header

AUTHORIZATION

string

Yes

The integrator token created previously

header

X-COMPANY-ID

string

Yes

The unique identifier (UID) for the company provided by us

body

body

boh_post_body_4

Yes

The pos_code for the employee validation

Responses

Code

Description

Schema

200

Success

400

Bad request. For more information, look at the body error.

401

Unauthorized error

403

Forbidden error

404

Not found

422

Unprocessable error

500

Internal server error

PATCH /pos-count

Summary

Send point of sale (POS) updates.

Request Parameters

In

Field Name

Type

Required

Description

header

CONTENT-TYPE

string

Yes

application/json

header

AUTHORIZATION

string

Yes

The integrator token created previously

header

X-COMPANY-ID

string

Yes

The unique identifier (UID) for the company provided by us

body

body

pos_count_patch_body_5

Yes

The request information

Responses

Code

Description

Schema

204

No content

400

Bad request. For more information, look at the body error.

401

Unauthorized error

403

Forbidden error

404

Not found

422

Unprocessable error

500

Internal server error

Data Models

app_info_get_response_1

Field Name

Type

Description

build

string

platformName

string

The platform name

platformVersion

string

The platform version

serverTimestamp

string (date-time)

East Eight District Time

serverTimestampUTC

string (date-time)

The server timestamp in Coordinated Universal Time (UTC)

app_info_get_response_2

Field Name

Type

Description

appCode

string

The application code for External Application

appName

string

The application name for External Application

appVersion

string

The application version for External Application

info

string

External information about the application

serverTimestamp

string (date-time)

The server timestamp

serverTimestampUTC

string (date-time)

The server timestamp in Coordinated Universal Time (UTC)

stage

string

The stage name. For example: dev, devlab, qa, uat, prod

appDeploymentRegion

string

The region where the application is deployed

statusCode

string

The status code of the application

statusMessage

string

The status of the application

url

string

The URL of the application

boh_post_body_3

Field Name

Type

Required

Description

pos_code

string

Yes

The POS code

password

string

Yes

The password

boh_post_body_4

Field Name

Type

Required

Description

pos_code

string

Yes

The POS code

pos_count_patch_body_5

Field Name

Type

Required

Description

event_id

string

Yes

The objectID, event identifier.

Minimum length: 24

Maximum length: 24

site_id

string

Yes

The objectID, site identifier.

Minimum length: 24

Maximum length: 24

employee_id

string

Yes

The objectID, employee identifier.

Minimum length: 24

Maximum length: 24

count_type

string

Yes

The POS count type.

Enum: Array [start, end]

count_date

string (date-time)

Yes

items

pos_count_patch_body_5_items

Yes

Minimum items: 1

pos_count_patch_body_5_items

Field Name

Type

Required

Description

inventory_item_entity_id

string

Yes

The objectID, The inventory item entity identifier.

Minimum length: 24

Maximum length: 24

count

number

No

Minimum: 0

gratis

number

No

Minimum: 0

spoil

number

No

The ingredient spoil.

Minimum: 0

Sample Code

GET Health Success

{
  "build": "string",
  "platformName": "string",
  "platformVersion": "string",
  "serverTimestamp": "string",
  "serverTimestampUTC": "2024-08-07T16:01:34.493Z"
}

GET Application Information

{
  "appCode": "string",
  "appName": "string",
  "appVersion": "string",
  "info": "string",
  "serverTimestamp": "2024-08-07T18:18:24.969Z",
  "serverTimestampUTC": "2024-08-07T18:18:24.969Z",
  "stage": "string",
  "appDeploymentRegion": "string",
  "statusCode": "string",
  "statusMessage": "string",
  "url": "string"
}

POST boh_auth_pos-login Request Body

{
  "pos_code": "string",
  "password": "string"
}

POST boh_employee_validate Request Body

{
  "pos_code": "string"
}

PATCH pos_count Request Body

{
  "event_id": "stringstringstringstring",
  "site_id": "stringstringstringstring",
  "employee_id": "stringstringstringstring",
  "count_type": "start",
  "count_date": "2024-08-07T15:57:23.837Z",
  "items": [
    {
      "inventory_item_entity_id": "stringstringstringstring",
      "count": 0,
      "gratis": 0,
      "spoil": 0
    }
  ]
}
See also: