Skip to main content
GET
/
business
/
{business_id}
Business information
curl --request GET \
  --url https://api.partoo.co/v2/business/{business_id} \
  --header 'x-APIKey: <api-key>'
{
  "id": "5409c35a97bbc544d8e26737",
  "created": 1409925979.5,
  "modified": 1561335111.681374,
  "code": "CS-75019",
  "status": "open",
  "opening_date": "2025-01-01",
  "org_id": 42,
  "group_id": 23,
  "groups": [
    1,
    2,
    3
  ],
  "name": "Corner shop",
  "address": "<string>",
  "address_full": "12 bis rue du coquelicot",
  "address2": "<string>",
  "city": "Paris",
  "zipcode": "75019",
  "region": "Ile-de-France",
  "country": "FR",
  "default_lang": "fr",
  "categories": [
    "gcid:restaurant",
    "gcid:fast_food_restaurant",
    "gcid:hamburger_restaurant"
  ],
  "time_slot_reference": [
    "10:00-14:00"
  ],
  "open_hours": {
    "monday": [
      "10:00-14:00"
    ],
    "tuesday": [
      "10:00-14:00"
    ],
    "wednesday": [
      "10:00-14:00"
    ],
    "thursday": [
      "10:00-14:00"
    ],
    "friday": [
      "10:00-14:00"
    ],
    "saturday": [
      "10:00-14:00"
    ],
    "sunday": [
      "10:00-14:00"
    ]
  },
  "specific_hours": {
    "open": [
      {
        "starts_at": "2020-01-20",
        "ends_at": "2020-01-20",
        "open_hours": [
          "10:00-14:00"
        ]
      }
    ],
    "close": [
      {
        "starts_at": "2020-01-20",
        "ends_at": "2020-01-22"
      }
    ]
  },
  "description_short": "lorem ipsum",
  "description_long": "lorem ipsum dolor sit amet",
  "website_url": "https://www.corner-shop.co/",
  "facebook_url": "https://www.facebook.com/the-corner-shop",
  "twitter_url": "https://www.twitter.com/the-corner-shop",
  "google_location_id": "<string>",
  "facebook_page_id": "<string>",
  "national_identification_number": "<string>",
  "logo_url": "<string>",
  "contacts": [
    {
      "name": "Hubert Bonisseur de la Bath",
      "email": "hubert@oss117.fr",
      "phone_numbers": [
        "+33302060628"
      ],
      "fax": "+33302060629"
    }
  ],
  "photos": {
    "LOGO": "<string>",
    "primary": "<string>",
    "secondary": [
      "<string>"
    ]
  },
  "lat": -3.585993,
  "long": 47.870341,
  "subscriptions": {
    "presence_management": {
      "active": true
    },
    "review_management": {
      "active": true
    },
    "review_booster": {
      "active": false
    },
    "messages": {
      "active": false
    }
  },
  "features": [
    "business_edition",
    "diffusion",
    "review_management",
    "review_invite",
    "messages"
  ],
  "custom_fields": [
    {
      "id": 1,
      "type": "BOOLEAN",
      "name": "Parking",
      "value": true,
      "order": 1
    },
    {
      "id": 2,
      "type": "TEXT",
      "name": "ManagerName",
      "value": "toto",
      "order": 2
    },
    {
      "id": 3,
      "type": "TEXT",
      "name": "Supervisor",
      "value": null,
      "order": 2
    },
    {
      "id": 4,
      "type": "INTEGER",
      "name": "Surface",
      "value": 2,
      "order": 3
    },
    {
      "id": 5,
      "type": "FLOAT",
      "name": "DistanceFromSubway",
      "value": 2.55,
      "order": 4
    },
    {
      "id": 6,
      "type": "SINGLE_SELECT",
      "name": "Level",
      "value": "two",
      "order": 4
    },
    {
      "id": 7,
      "type": "MULTIPLE_SELECT",
      "name": "Services",
      "value": [
        "one",
        "two"
      ],
      "order": 5
    },
    {
      "id": 8,
      "type": "MULTIPLE_SELECT_IMAGE",
      "name": "BannerImage",
      "value": [
        "image 1",
        "image 2"
      ],
      "order": 6
    },
    {
      "id": 9,
      "type": "IMAGES_UPLOADER",
      "name": "TeamMembers",
      "value": [
        {
          "url": "image1",
          "texts": {
            "name1": "value 1",
            "name2": "value 2"
          }
        }
      ],
      "order": 7
    }
  ],
  "completion_rate": 77,
  "promos": [
    {
      "title": "<string>",
      "description": "<string>",
      "term_of_use": "<string>",
      "additional_informations": "<string>",
      "begin": 123,
      "end": 123,
      "images": [
        "<string>"
      ],
      "client_offer_url": "<string>",
      "promo_url": "<string>"
    }
  ]
}

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Path Parameters

​
business_id
string
required

Business id.

It may be replaced by c-{code} where code is the store code, which should be unique per organization. This can be used only for ORG_ADMIN, GROUP_MANAGER and BUSINESS_MANAGER users.

Response

OK

Partoo App Business

​
id
string

Business id

Example:

"5409c35a97bbc544d8e26737"

​
created
number

Timestamp (in seconds) of the business creation

Example:

1409925979.5

​
modified
number

Timestamp (in seconds) of the business last modification. Doesn’t take into account changes to the Custom Fields or related objects.

Example:

1561335111.681374

​
code
string

The unique store code of the business. If not provided, it will be automatically generated

Example:

"CS-75019"

​
status
enum<string>
default:open

Defines the current status of the business. open indicates the business is up and running. closed means that the business has definitely closed. temporarily_closed means that the business is temporarily closed, it is advised when your business is closed for more than one week, otherwise use the specific_hours

Available options:
open,
closed,
temporarily_closed
Example:

"open"

​
opening_date
string<YYYY-MM-DD>

The opening_date represents the date when a business was opened. The format of the date must be in ISO 8601 format (YYYY-MM-DD). ⚠️ The date must be in the past or no more than one year in the future from the current date (Google API requirement).

Example:

"2025-01-01"

​
org_id
integer

The organization unique identifier at Partoo. During onboarding, Partoo creates an organization where all your businesses will be aggregated

Example:

42

​
group_id
integer
deprecated

The id of the group the business belongs to. An organization can have multiple groups that contain one or more businesses. A business can belong to only one group.

Example:

23

​
groups
integer[]

List of Group ID of the business.

Groups the business belongs to.

See the Groups and Sections description

Example:
[1, 2, 3]
​
name
string

The name of the business (POI) as it will appear on the publishing platforms

Minimum length: 1
Example:

"Corner shop"

​
address
string | null

Business address. This fields returns the same value as the field address_full for historical reasons. You should prefer the use address_full.

​
address_full
string | null

Full address of the business.

For example : 130 Rue du Mont-Cenis.

Example:

"12 bis rue du coquelicot"

​
address2
string | null

Complement of address. Any additional information that could help better find the business location

​
city
string | null

The city where the business is located

Example:

"Paris"

​
zipcode
string | null

Zipcode (or postal code) for the business address. Can be empty if the business' country does not require one.

Example:

"75019"

​
region
string | null

The region where the business is located. Can be empty, it is only useful for some countries like Italy or Spain among others.

Example:

"Ile-de-France"

​
country
string

Business country - In the ISO 3166 alpha2 code format (i.e. use “FR” for France instead of "fr")

Example:

"FR"

​
default_lang
string

Business default language - it either corresponds to the country's default language or set as English by default

Example:

"fr"

​
categories
string[]

A list of category ids mapped to the business. At least one category needs to be provided. For more information see Categories section

Minimum length: 1
Example:
[
  "gcid:restaurant",
  "gcid:fast_food_restaurant",
  "gcid:hamburger_restaurant"
]
​
time_slot_reference
string[]

Default time period, can be used to set open hours of a day from Partoo's interface.

Time window

​
open_hours
object

The opening hours of the business (in its timezone).

Opening hours are specified per weekday. This is done by supplying an object mapping weekdays ("monday", "tuesday", etc.) to a list of strings. These strings in turn represent time slots during which the business is open.

For example, the following value would set the opening hours to between 08:00-15:00 in the afternoon and 18:00-23:00 in the evening on Mondays:
{"monday": ["08:00-15:00", "18:00-23:00"]}

To indicate that a business is open 24 hours for a specific weekday, use the value ["00:00-23:59"].

❗ This field is not mandatory, but if not provided then the business will not be pushed on some platforms (example: Google).
If provided, then a schedule needs to be sent for each day in particular.

​
specific_hours
object

Exceptional opening or closing times for the business (in its timezone).

All exceptional days of the year, including temporarily closed, can be specified beforehand or on the go. For example:

  • Beforehand: bank holidays (like Christmas or Labor Day)
  • Unpredicted: COVID-19 exceptional situation

Specific hours are defined by two values:

  • open, containing a list of days with exceptional opening hours
  • close, containing a list of days where the business is exceptionally closed all day

These values in turn contain:

  • starts_at indicating the first date for which the exceptional hours are valid
  • ends_at indicating the last date (inclusive) for which the exceptional hours are valid
  • open_hours (only used for days with exceptional opening hours) indicating the actual time slots for the given period, following the same pattern as the time slots in open_hours
​
description_short
string

A short description of the business.

⚠️ It is limited to 80 characters

Example:

"lorem ipsum"

​
description_long
string

A more detailed description of the business.

⚠️ It is limited to 750 characters

Example:

"lorem ipsum dolor sit amet"

​
website_url
string<uri>

The business own website url or the main url of the company.

Example:

"https://www.corner-shop.co/"

​
facebook_url
string<uri>

Business Facebook page url

Example:

"https://www.facebook.com/the-corner-shop"

​
twitter_url
string<uri>

Business twitter page url

Example:

"https://www.twitter.com/the-corner-shop"

​
google_location_id
string

Id of Google Location to which the business is linked

​
facebook_page_id
string

Id of Facebook Location to which the business is linked

​
national_identification_number
string

The National Identification Number of the business.

It describes a unique number for which the business is registered in a specific country.
For example, in France, it's the SIRET code, or for Ireland, it's the CRO.

​
logo_url
string<uri>

Business LOGO URL

​
contacts
object[]

Specify how the clients can reach the persons in charge of the business in case they have questions.

​
photos
object

Business photos

Each business can have one or more photos associated

​
lat
number | null

Latitude pushed on publishers. Decimals are separated by a dot and not by a comma.

Example:

-3.585993

​
long
number | null

Longitude pushed on publishers. Decimals are separated by a dot and not by a comma.

Example:

47.870341

​
subscriptions
object
deprecated

Business product subscriptions. Deprecated, use features instead.

Example:
{
  "presence_management": { "active": true },
  "review_management": { "active": true },
  "review_booster": { "active": false },
  "messages": { "active": false }
}
​
features
enum<string>[]

List of business' features.

Example:
[
  "business_edition",
  "diffusion",
  "review_management",
  "review_invite",
  "messages"
]
​
custom_fields
object[]

Custom Fields set for this Business

They represent configurable fields that can be defined in addition to the normal business fields proposed by Partoo.

They are unique to the organization and can be entirely adapted to the company's needs.

  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
  • Option 7
  • Option 8
Example:
[
  {
    "id": 1,
    "type": "BOOLEAN",
    "name": "Parking",
    "value": true,
    "order": 1
  },
  {
    "id": 2,
    "type": "TEXT",
    "name": "ManagerName",
    "value": "toto",
    "order": 2
  },
  {
    "id": 3,
    "type": "TEXT",
    "name": "Supervisor",
    "value": null,
    "order": 2
  },
  {
    "id": 4,
    "type": "INTEGER",
    "name": "Surface",
    "value": 2,
    "order": 3
  },
  {
    "id": 5,
    "type": "FLOAT",
    "name": "DistanceFromSubway",
    "value": 2.55,
    "order": 4
  },
  {
    "id": 6,
    "type": "SINGLE_SELECT",
    "name": "Level",
    "value": "two",
    "order": 4
  },
  {
    "id": 7,
    "type": "MULTIPLE_SELECT",
    "name": "Services",
    "value": ["one", "two"],
    "order": 5
  },
  {
    "id": 8,
    "type": "MULTIPLE_SELECT_IMAGE",
    "name": "BannerImage",
    "value": ["image 1", "image 2"],
    "order": 6
  },
  {
    "id": 9,
    "type": "IMAGES_UPLOADER",
    "name": "TeamMembers",
    "value": [
      {
        "url": "image1",
        "texts": { "name1": "value 1", "name2": "value 2" }
      }
    ],
    "order": 7
  }
]
​
completion_rate
integer

The completion rate percentage of the business.

The completion rate is calculated based on how many fields are filled for the business.
If some necessary fields are not filled, it will lower the completion rate.

⚠️ After the update of the business, it may take up to 24 hours for this field to be updated.

Example:

77

​
promos
object[]
deprecated