Skip to content

Organisations

Returns list of organisations in the system. Returned data can be limited with organisation_id query parameters.

Operations

Download organisations as JSON

Request

GET https://api.zoined.com/v2/download/organisations.json?limit=1000&offset=0&organisation_id=123k

Security
bearerAuth
Query
limitnumber

How many entries to return

Example:limit=1000
offsetnumber

Which offset to return data from

Example:offset=0
organisation_idstring

Returns data of organisation based on the given id

Example:organisation_id=123k
curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/organisations.json?limit=1000&offset=0&organisation_id=123k' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
organisation_idstringrequired

Organisation / Store ID

Example:"540"
organisation_namestringrequired

Organisation name

Example:"Web Sales"
areastring

Sales area

Example:"South"
latitudenumber

Latitude

Example:60.184014
longitudenumber

Longitude

Example:24.960046
channelstring

Sales channel

Example:"Concession"
floor_areanumber

Store area eg. in m2

Example:250
no_customer_seatsnumber

Number of customer seats in store

Example:150
organisation_typestring

Outlet / Brand / Essential

Example:"Outlet"
organisation_groupstring

Organisation group

Example:"A"
google_location_urlstring

Google review location URL

Example:"https://www.google.com/maps/reviews?data=XYZ"
image_urlstring

Url for external store image file

Example:"http://example.com?product=XYZ"
store_statusstring

Status of store

Enum ValueDescription
open

Store is open and active

closed

Store has been closed down permanently

temporarily_closed

Store has been closed temporarily

Example:"closed"
custom_dimension1string

Custom Field 1

Example:"Class 3"
custom_dimension2string

Custom Field 2

Example:"Class 3"
custom_dimension3string

Custom Field 3

Example:"Class 3"
custom_dimension4string

Custom Field 4

Example:"Class 3"
custom_dimension5string

Custom Field 5

Example:"Class 3"
Response
{
  "organisation_id": "540",
  "organisation_name": "Web Sales",
  "area": "South",
  "latitude": 60.184014,
  "longitude": 24.960046,
  "channel": "Concession",
  "floor_area": 250,
  "no_customer_seats": 150,
  "organisation_type": "Outlet",
  "organisation_group": "A",
  "google_location_url": "https://www.google.com/maps/reviews?data=XYZ",
  "image_url": "http://example.com?product=XYZ",
  "store_status": "closed",
  "custom_dimension1": "Class 3",
  "custom_dimension2": "Class 3",
  "custom_dimension3": "Class 3",
  "custom_dimension4": "Class 3",
  "custom_dimension5": "Class 3"
}