Adding a business

Overview
Version-specific information
Permissions and Authentication
Headers
HTTP Parameters
Example response JSON

Overview

Call name: add-business
Endpoint URL: https://api0.spaaza.com/internal/add-business
Request methods: POST
Request Content-Type: multipart/form-data or application/x-www-form-urlencoded or application/json
Response Content-Type: application/json
Auth required: yes

In Spaaza terminology, a “business” is a branch of a retailer (a “chain”). This API call adds a new business.

Version-specific information

The following version-specific changes apply to this endpoint. See the versioning page for more details.

Version	Change details
N/A	N/A

Permissions and Authentication

This API call requires a valid Spaaza session. See the authentication page for more details. The session can be as follows:

Admin authentication: The performing user needs to be logged in and have write access to the chain to which the user is connected.

Headers

The following headers can/must be passed to the API call:

Parameter	Description
N/A	N/A

HTTP Parameters

The following HTTP parameters can be passed to the API:

«««< HEAD | Parameter | Description | |——————–|————————————————————————————————————————————————————————————————-| | chain_id | (integer, mandatory) The chain_id of the chain to which the business belongs | | address_1 | (string, optional, max=128) The first line of the business address | | address_2 | (string, optional, max=128) The second line of the business address | | address_3 | (string, optional, max=128) The third line of the business address | | countrycode | (string, optional, length=2) The ISO ALPHA-2 2-letter country code of the business (e.g., “NL”, “BE”, “DE”) | | description | (string, optional, max=512) A description of the business | | email_address | (string, optional, max=255) The email address for the business. Must be a valid email format | | facebook_url | (string, optional, max=255) The Facebook URL for the business | | fax_number | (string, optional, max=32) The fax number for the business | | format | (string, optional, max=64) The store format of the business (e.g., “Metro”, “Express”) | | google_place_id | (string, optional, max=1024) The Google Place ID of the store/business | | image_url | (string, optional, max=512) The URL link to the business’s image/logo | | imagefile | (file, optional) Business image/logo file to upload. Supported formats: JPEG, PNG. Max size: 5MB, max dimensions: 5000x5000px | | is_shut_down | (boolean, optional) Whether the business is administratively shut down. Default: false | | latitude | (float, optional) The latitude of the business in decimal degrees. Must be between -90 and +90. Required if longitude is provided | | linkedin_url | (string, optional, max=255) The LinkedIn URL for the business | | longitude | (float, optional) The longitude of the business in decimal degrees. Must be between -180 and +180. Required if latitude is provided | | name | (string, mandatory, max=255) The name of the business | | opening_times | (string, optional, max=2048) The opening times of the business in JSON format. See example response for format | | owner_code | (string, optional, max=64) The retailer owner_code for the store. Must be unique within the chain | | phone_number | (string, optional, max=32) The phone number for the business | | postalcode | (string, optional, max=20) The postal code of the business. Format validation applies for:
- NL: “1234 AB” format
- DE: “12345” or “D-12345” format
- BE: “1234” or “1234 BE” format | | programme_opted_in | (boolean, optional) Whether the business participates in the loyalty programme. Default: true | | region | (string, optional, max=56) The region or state of the business | | review_url | (string, optional, max=512) The URL link to the review business page | | towncity | (string, optional, max=56) The postal city of the business | | twitter_username | (string, optional, max=15) The Twitter username for the business (without @ symbol) | | update_if_exists | (boolean, optional) If true and either business_id or owner_code is provided, updates an existing business instead of creating a new one. Default: false | | website_url | (string, optional, max=255) The website URL for the business |

Possible error responses

*Updating a existing business using add-business It is possible to update an existing business using the add-business endpoint. To do this, you need to pass the update_if_exists parameter as true and the business_id or owner_code parameter must be passed to identify an existing business.

origin/develop

Example response JSON

The endpoint returns JSON showing the details associated with the business. An example response is shown below:

{
    "result": {
        "code": 1,
        "status": "ok"
    },
    "results": {
        "business": {
            "address_1": "Herengracht 504",
            "address_2": "Foo",
            "address_3": "Bar",
            "business_format": "Metro",
            "chain_id": 1743,
            "created_date":"2024-04-03T12:43:54+00:00",
            "countrycode": "NL",
            "deleted": false,
            "deleted_by": null,
            "email_address": "ops@spaaza.com",
            "format": "Metro",
            "google_place_id": null,
            "id": 1383,
            "image_url": "https://media.licdn.com/dms/image/C4D0BAQEN6wx-nP_Crg/company-logo_400_400/0?e=1578528000&v=beta&t=1qKTWg0qbIJMydHHG02YPhD8N4LONyW5Rp06wn5DvN0",
            "is_shut_down": false,
            "last_modified_date":"2024-04-03T12:43:54+00:00",
            "latitude": "52.37021570",
            "longitude": "1.89516789",
            "name": "ACME Inc",
            "opening_times": "{\"monday\": {\"open\": \"11:00\",\"close\": \"18:00\" }, \"tuesday\": { \"open\": \"09:30\", \"close\": \"18:00\" }, \"wednesday\": { \"open\": \"09:30\", \"close\": \"18:00\" }, \"thursday\": { \"open\": \"09:30\", \"close\": \"18:00\" }, \"friday\": { \"open\": \"09:30\", \"close\": \"21:00\" }, \"saturday\": { \"open\": \"09:30\", \"close\": \"17:00\" }, \"sunday\": { \"open\": \"Elke laatste zondag van de maand\", \"close\": \"12:00-17:00\" }, \"special_hours\": [ { \"date\": \"23\/02\/2020\", \"open\": \"12:00\", \"close\": \"17:00\", \"reason\": \"Laatste zondag van de maand\" }, { \"date\": \"23\/02\/2020\", \"open\": \"-\", \"close\": \"-\", \"reason\": \"Carnaval\" } ] }",
            "owner_code": "10001",
            "phone_number": "0124141",
            "postalcode": "1017 CB",
            "programme_opted_in": true,
            "region": "Noord Holland",
            "towncity": "Amsterdam",
            "review_url" : "https://g.page/spaaza/review",
            "type": "business",
            "website_url": "https://www.spaaza.com"
        },
        "result_type": "add-business"
    }
}