Skip to content

Organisations

Organisations are the sales locations. They can be physical stores, web commerce sites, warehouses or personal payment terminals.

Operations

Upload list of organisation units

Request

POST https://api.zoined.com/organisations?dryRun=false&separator=%3B&encoding=utf-8

Security
bearerAuth
Query
dryRunbooleanrequired

Only validate the request without storing the data

Example:dryRun=false
separatorstringrequired

Column separator used when loading CSV data

Example:separator=;
encodingstringrequired

Character encoding used in the CSV data (default is utf-8)

Example:encoding=utf-8
Body
Any of:
organisation_idstringrequired

Organisation / Store ID

Example:"540"
organisation_namestringrequired

Organisation name

Example:"Web Sales"
street_addressstring

Street address

Example:"Mannerheimintie 1"
citystring

City

Example:"Helsinki"
post_codestring

Postal code

Example:"00100"
statestring

State

Example:"Southern Finland"
countrystring

Country

Example:"Finland"
areastring

Sales area

Example:"South"
latitudenumber

Latitude

Example:60.184014
longitudenumber

Longitude

Example:24.960046
channelstring

Sales channel

Example:"Concession"
organisation_typestring

Outlet / Brand / Essential

Example:"Outlet"
organisation_groupstring

Organisation group

Example:"A"
floor_areanumber

Store floor area eg. in m2

Example:123.5
no_customer_seatsnumber

Number of customer seats in store

Example:150
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:"open"
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"
source_systemstring

Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.

Example:"ABCDEF"
curl -i -X POST \
  'https://zapi-api.zoined.com/_mock/organisations?dryRun=false&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "organisation_id": "540",
    "organisation_name": "Web Sales",
    "street_address": "Mannerheimintie 1",
    "city": "Helsinki",
    "post_code": "00100",
    "state": "Southern Finland",
    "country": "Finland",
    "area": "South",
    "latitude": 60.184014,
    "longitude": 24.960046,
    "channel": "Concession",
    "organisation_type": "Outlet",
    "organisation_group": "A",
    "floor_area": 123.5,
    "no_customer_seats": 150,
    "google_location_url": "https://www.google.com/maps/reviews?data=XYZ",
    "image_url": "http://example.com?product=XYZ",
    "store_status": "open",
    "custom_dimension1": "Class 3",
    "custom_dimension2": "Class 3",
    "custom_dimension3": "Class 3",
    "custom_dimension4": "Class 3",
    "custom_dimension5": "Class 3",
    "source_system": "ABCDEF"
  }'

Responses

Request has been processed successfully.

Headers

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

Status of the operation OK / Not OK

Example:"OK"
msgstringrequired

Message describing result of operation

Example:"1 entity added"
Response
{
  "status": "OK",
  "msg": "1 entity added"
}