Skip to main content
POST

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.

Body

application/json

Partial business update for simulating changes

​
name
string

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

Minimum string length: 1
Example:

"Corner shop"

​
org_id
integer

Unique identifier of an organization in Partoo.

Example:

42

​
country
string

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

Example:

"FR"

​
zipcode
string | null

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

Example:

"75019"

​
city
string | null

The city where the business is located

Example:

"Paris"

​
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"

​
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 array length: 1
Example:
​
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. 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

Available options:
open,
closed,
closed_temporarily
Example:

"open"

​
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

​
manual_lat
number<double>

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

Example:

-3.585993

​
manual_long
number<double>

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

Example:

47.870341

​
lat
number<double>

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

Example:

-3.585993

​
long
number<double>

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

Example:

47.870341

​
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"

​
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"

​
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
​
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

​
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.

Response

OK

Diffusion errors grouped by section and field

​
address
object

Errors in the address section

​
infos
object

Errors in the infos section

​
advanced-settings
object

Errors in the advanced settings section