Retrieve your location details
GET ~/location
Headers
Field | Type | Description |
---|---|---|
Authorization | String |
Bearer authentication token prefixed with |
Content-Type | String |
Request content type, must be 'application/json' |
vendor | String |
The POS vendor name retrieved from Doshii dashboard |
Response
Field | Type | Description |
---|---|---|
id | String |
Hashed id for this Location |
name | String |
The name of the Location |
addressLine1 | String |
First line for address |
addressLine2 | String |
Second line for address |
city | String |
City of the Location |
state | String |
State of the Location |
country | String |
Country 2 letters identifier where the Location is in |
postalCode | String |
Postcode of the Location |
phoneNumber | String |
Phone number for the Location |
disconnectedDate | String |
The time when the Location disconnected from Doshii |
latitude | String |
The location latitude coordinate |
longitude | String |
The location longitude coordinate |
vendorId | String |
The id of the vendor |
organisationId | String |
The id of the Organisation |
Organisation | Object |
The location's organisation object |
id | String |
The hashed id for the Organisation |
name | String |
Organisations' name |
phone | String |
Organisations' phone |
String |
Organisations' email |
|
addressLine1 | String |
Organisations' first line for address |
addressLine2 | String |
Organisations' second line for address |
city | String |
Organisations' city |
state | String |
Organisations' state |
postalCode | String |
Organisations' postalCode |
country | String |
Organisations' country 2 letters identifier |
createdAt | String |
Organisations' record creation date |
updatedAt | String |
Organisations' record last update date |
uri | String |
Organisations' object details url |
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":"2X3b8q",
"name":"Chicken's R Us",
"addressLine1":"616 St Kilda Road",
"addressLine2":"Level 8",
"city":"Melbourne",
"state":"VIC",
"postalCode":"3004",
"country":"AU",
"phoneNumber":"01234567890",
"disconnectedDate":null,
"latitude":null,
"longitude":null,
"vendorId": "1",
"organisationId": "5X3b8n",
"Organisation": {
"id": "5X3b8n",
"name": "Test Org",
"phone": "1234 567 891",
"email": "test@org.com.au",
"addressLine1": "616 St Kilda Road",
"addressLine2": "Level 8",
"city": "Melbourne",
"state": "VIC",
"country": "AU",
"postalCode": null,
"createdAt": "2016-06-22T00:35:54.967Z",
"updatedAt": "2016-06-30T01:23:02.825Z",
"uri": "https://sandbox.doshii.co/pos/v3/organisations/5X3b8n"
},
"createdAt": "2016-06-30T01:23:28.371Z",
"updatedAt": "2016-08-18T03:20:32.720Z",
"uri": "https://sandbox.doshii.co/pos/v3/location/2X3b8q"
}
Comments
0 comments
Please sign in to leave a comment.