appReady

This command retrieves relevant information from Oliver based on the purpose of the environment (view). The view attribute options are :

• ‘Checkout’ / ‘Delivery Checkout’ - Returns Client GUID

• ‘Customer View’ - Returns Customer ID

• ‘Activity View’ - Returns Order ID

• ‘Product View’ - Returns Product ID

GET

Description:
Retrieves information from the checkout page. Oliver responds with the client guid, the view (the page the app is being launched from), privilege (whether the current user is an admin, a store manager or a cashier), and the view port (the device on which Oliver is being run on).

Request Body:

JSON

{ 
command: 'appReady', 
method: 'get', 
version: '1.0' 
}

Response Body:

JSON

{ 
command: 'appReady', 
method: 'get', 
version: '1.0', 
status: 200, 
data: 
{ 
clientGUID: '6eaab-4ffierori-4utidfokmt-695kgtrg', 
view: 'Checkout', 
privilege: 'admin', 
viewport: 'desktop' 
}, 
error: null 
}

Parameters:

Attribute Name

Attribute Type

Description

Required (binary)

command

string

High level command name to interact with Oliver

1

method

string

These correspond to create, read, update, and delete (or CRUD) operations

1

version

string

The version of the command used

1

Response Body: - Customer View:

JSON

{ 
command: 'appReady', 
method: 'get', 
version: '1.0', 
status: 200, 
data: 
{ 
CustomerId: 40, 
clientGUID: "6daed7e2-c749-4636-b75a-a5063c980a6f", 
privilege: "owner", 
view: "CustomerView", 
viewport: "desktop" ' 
},
error: null 
}

Response Body: - Activity View:

JSON

{ 
command: 'appReady', 
method: 'get', 
version: '1.0', 
status: 200, 
data: 
{ 
OrderId: 16970, WooCommerceId: 0, 
clientGUID: "6daed7e2-c749-4636-b75a-a5063c980a6f", 
privilege: "owner", 
view: "CustomerView", 
viewport: "desktop" ' 
}, 
error: null 
}