Sign in

v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB
Businesses

Create business

This API allows the creation of a new business in the context of your organization.

post/business

Request body

namestring required

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

org_idinteger

Unique identifier of the organization to which the business should belong. Only PROVIDER users can set this field. If no org_id is given, this will default to the ID of your organization.

groupsinteger[]

List of Group ID of the business.

Groups the business belongs to.

See the Groups and Sections description

reach'LOCAL' | 'GLOBAL'

Defines whether the business is a physical entity with an address (LOCAL) or a Brand (GLOBAL).

countrystring required

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

zipcodestring nullable

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

citystring

The city where the business is located.

Required if 'reach' is not specified or set to 'LOCAL'.

regionstring nullable

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

categoriesstring[] required

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

codestring

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

status'open' | 'closed' | 'closed_temporarily'

Defines the current status of the business. open indicates the business is up and running. closed means that the business has definitely closed. closed_temporarily 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

opening_datestring 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).

address_fullstring nullable

Full address of the business.

For example : 130 Rue du Mont-Cenis.

address2string nullable

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

latnumber double

Latitude. Decimals are separated by a dot and not by a comma.

longnumber double

Longitude. Decimals are separated by a dot and not by a comma.

website_urlstring uri

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

facebook_urlstring uri

Business Facebook page url

twitter_urlstring uri

Business twitter page url

description_shortstring

A short description of the business.

⚠️ It is limited to 80 characters

description_longstring

A more detailed description of the business.

⚠️ It is limited to 750 characters

national_identification_numberstring

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.

custom_fieldsCustomFieldsUpdate

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 should suit your company needs.

Example request

{
  "name": "Corner shop",
  "org_id": 42,
  "groups": [
    1,
    2,
    3
  ],
  "reach": "LOCAL",
  "country": "FR",
  "zipcode": "75019",
  "city": "Paris",
  "region": "Ile-de-France",
  "categories": [
    "gcid:restaurant",
    "gcid:fast_food_restaurant",
    "gcid:hamburger_restaurant"
  ],
  "code": "CS-75019",
  "status": "open",
  "opening_date": "2025-01-01",
  "address_full": "12 bis rue du coquelicot",
  "lat": -3.585993,
  "long": 47.870341,
  "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",
  "description_short": "lorem ipsum",
  "description_long": "lorem ipsum dolor sit amet",
  "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"
      }
    ]
  },
  "contacts": [
    {
      "name": "Hubert Bonisseur de la Bath",
      "email": "hubert@oss117.fr",
      "phone_numbers": [
        "+33302060628"
      ],
      "fax": "+33302060629"
    }
  ],
  "custom_fields": {
    "Parking": true,
    "ManagerName": "toto",
    "Surface": 35,
    "DistanceFromSubway": 1.5,
    "Level": "one",
    "Services": [
      "DisabledAccess",
      "FreeParking"
    ],
    "BannerImage": [
      "image 1",
      "image 2"
    ],
    "TeamMembers": [
      {
        "url": "image1",
        "texts": {
          "name1": "value 1",
          "name2": "value 2"
        }
      }
    ]
  }
}

Response

OK

status'success'

Request status

idstring

Business id

Example response

{
  "id": "5409c35a97bbc544d8e26737"
}