Ceate Employee – Doshii Guide

Create a new Employee for your location

POST ~/employees

Headers

Field Type Description

Authorization

String

Bearer authentication token prefixed with Bearer and a space. See Authentication for more information.

Content-Type

String

Request content type, must be 'application/json'

vendor

String

The POS vendor name retrieved from Doshii dashboard

Parameters

Field	Type	Description
name	string	The employees' full name
posRefoptional	string	The Point of Sales' internal reference
emailoptional	string	The employees' email
phoneoptional	string	The employees' phone number
addressoptional	Object	An object containing the employees' address details
line1optional	String	Address line 1
line2optional	String	Address line 2
stateoptional	String	State
cityoptional	String	City
countryoptional	String	Country
postalCodeoptional	String	Postcode

Response

Field	Type	Description
id	String	Unique number identifying this resource
locationId	String	The location this employe relates to
posRef	String	A free-text field for entering POS internal identifiers
name	String	The employees' full name
email	String	The employees' email address
address	Object	An object containing the employees' address details
line1	String	Address line 1
line2	String	Address line 2
state	String	State
city	String	City
country	String	Country
postalCode	String	Postcode
phone	String	The employees' phone number
updatedAt	String	Date when the record is last updated
createdAt	String	Date when the record is created
uri	String	The object details url

Examples

Response

{
 "id": "1",
 "locationId": "2xw32Bca",
 "posRef": "emp222",
 "name": "Jimmy Cann",
 "email": "jimmy@doshii.io",
 "address": {
   "city": "Melbourne",
   "line1": "111 Abc St",
   "line2": "222 Abc Dv",
   "state": "VIC",
   "country": "Australia",
   "postalCode": "3131"
 },
 "phone": "0455555555",
 "createdAt": "2017-02-07T09:27:05.525Z",
 "updatedAt": "2017-02-07T21:53:30.007Z",
 "uri": "http://localhost:2001/pos/v3/employees/1"
}