ServiceSystems SSQ API

SSQ V1 API

Customer

Customer - Call next (GET)

get
/api/call/customer/:id
/api/call/customer/21

Parameter

Field Type Description
id Number

The id of the till/agent to call to.

Size range: 1-50

msg optional String

Optional text message to override default call message.
url encode eg. ?&msg=Next%20Customer

200

Field Type Description
ok Boolean

Success.

400

Name Type Description
err String

Error message.

Send a Sample Request

url

Parameters

Parameter

Number
String

Supervisor

Supervisor - Call supervisor (GET)

get
/api/call/supervisor/:id
/api/call/supervisor/13

Parameter

Field Type Description
id Number

The id of the till/agent to call to.

Size range: 1-50

reason optional String

Optional reason message.
url encode. eg. ?&reason=void%20item

200

Field Type Description
ok Boolean

Success.

400

Name Type Description
err String

Error message.

Send a Sample Request

url

Parameters

Parameter

Number
String

Supervisor - Cancel supervisor call (GET)

get
/api/cancel/supervisor/:id
/api/cancel/supervisor/13

Parameter

Field Type Description
id Number

The id of the till/agent to call to.

Size range: 1-50

reason optional String

Optional reason message.
url encode. eg. ?&reason=Void%20Canceled

200

Field Type Description
ok Boolean

Success.

400

Name Type Description
err String

Error message.

Send a Sample Request

url

Parameters

Parameter

Number
String
Generated with apidoc 0.17.7 - 2019-07-19T12:54:22.229Z