Create business
curl --request POST \
--url https://api.partoo.co/v2/business \
--header 'Content-Type: application/json' \
--header 'x-APIKey: <api-key>' \
--data '
{
"name": "Corner shop",
"country": "FR",
"categories": [
"gcid:restaurant",
"gcid:fast_food_restaurant",
"gcid:hamburger_restaurant"
],
"contacts": [
{
"name": "Hubert Bonisseur de la Bath",
"email": "hubert@oss117.fr",
"phone_numbers": [
"+33302060628"
],
"fax": "+33302060629"
}
],
"org_id": 42,
"groups": [
1,
2,
3
],
"reach": "LOCAL",
"zipcode": "75019",
"city": "Paris",
"region": "Ile-de-France",
"code": "CS-75019",
"status": "open",
"opening_date": "2025-01-01",
"address_full": "12 bis rue du coquelicot",
"address2": "<string>",
"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",
"photos": {
"LOGO": "<string>",
"primary": "<string>",
"secondary": [
"<string>"
]
},
"national_identification_number": "<string>",
"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"
}
}
]
}
}
'import requests
url = "https://api.partoo.co/v2/business"
payload = {
"name": "Corner shop",
"country": "FR",
"categories": ["gcid:restaurant", "gcid:fast_food_restaurant", "gcid:hamburger_restaurant"],
"contacts": [
{
"name": "Hubert Bonisseur de la Bath",
"email": "hubert@oss117.fr",
"phone_numbers": ["+33302060628"],
"fax": "+33302060629"
}
],
"org_id": 42,
"groups": [1, 2, 3],
"reach": "LOCAL",
"zipcode": "75019",
"city": "Paris",
"region": "Ile-de-France",
"code": "CS-75019",
"status": "open",
"opening_date": "2025-01-01",
"address_full": "12 bis rue du coquelicot",
"address2": "<string>",
"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",
"photos": {
"LOGO": "<string>",
"primary": "<string>",
"secondary": ["<string>"]
},
"national_identification_number": "<string>",
"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"
}
}
]
}
}
headers = {
"x-APIKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-APIKey': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Corner shop',
country: 'FR',
categories: ['gcid:restaurant', 'gcid:fast_food_restaurant', 'gcid:hamburger_restaurant'],
contacts: [
{
name: 'Hubert Bonisseur de la Bath',
email: 'hubert@oss117.fr',
phone_numbers: ['+33302060628'],
fax: '+33302060629'
}
],
org_id: 42,
groups: [1, 2, 3],
reach: 'LOCAL',
zipcode: '75019',
city: 'Paris',
region: 'Ile-de-France',
code: 'CS-75019',
status: 'open',
opening_date: '2025-01-01',
address_full: '12 bis rue du coquelicot',
address2: '<string>',
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',
photos: {LOGO: '<string>', primary: '<string>', secondary: ['<string>']},
national_identification_number: '<string>',
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'}}]
}
})
};
fetch('https://api.partoo.co/v2/business', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.partoo.co/v2/business",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Corner shop',
'country' => 'FR',
'categories' => [
'gcid:restaurant',
'gcid:fast_food_restaurant',
'gcid:hamburger_restaurant'
],
'contacts' => [
[
'name' => 'Hubert Bonisseur de la Bath',
'email' => 'hubert@oss117.fr',
'phone_numbers' => [
'+33302060628'
],
'fax' => '+33302060629'
]
],
'org_id' => 42,
'groups' => [
1,
2,
3
],
'reach' => 'LOCAL',
'zipcode' => '75019',
'city' => 'Paris',
'region' => 'Ile-de-France',
'code' => 'CS-75019',
'status' => 'open',
'opening_date' => '2025-01-01',
'address_full' => '12 bis rue du coquelicot',
'address2' => '<string>',
'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',
'photos' => [
'LOGO' => '<string>',
'primary' => '<string>',
'secondary' => [
'<string>'
]
],
'national_identification_number' => '<string>',
'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'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-APIKey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.partoo.co/v2/business"
payload := strings.NewReader("{\n \"name\": \"Corner shop\",\n \"country\": \"FR\",\n \"categories\": [\n \"gcid:restaurant\",\n \"gcid:fast_food_restaurant\",\n \"gcid:hamburger_restaurant\"\n ],\n \"contacts\": [\n {\n \"name\": \"Hubert Bonisseur de la Bath\",\n \"email\": \"hubert@oss117.fr\",\n \"phone_numbers\": [\n \"+33302060628\"\n ],\n \"fax\": \"+33302060629\"\n }\n ],\n \"org_id\": 42,\n \"groups\": [\n 1,\n 2,\n 3\n ],\n \"reach\": \"LOCAL\",\n \"zipcode\": \"75019\",\n \"city\": \"Paris\",\n \"region\": \"Ile-de-France\",\n \"code\": \"CS-75019\",\n \"status\": \"open\",\n \"opening_date\": \"2025-01-01\",\n \"address_full\": \"12 bis rue du coquelicot\",\n \"address2\": \"<string>\",\n \"lat\": -3.585993,\n \"long\": 47.870341,\n \"website_url\": \"https://www.corner-shop.co/\",\n \"facebook_url\": \"https://www.facebook.com/the-corner-shop\",\n \"twitter_url\": \"https://www.twitter.com/the-corner-shop\",\n \"description_short\": \"lorem ipsum\",\n \"description_long\": \"lorem ipsum dolor sit amet\",\n \"photos\": {\n \"LOGO\": \"<string>\",\n \"primary\": \"<string>\",\n \"secondary\": [\n \"<string>\"\n ]\n },\n \"national_identification_number\": \"<string>\",\n \"custom_fields\": {\n \"Parking\": true,\n \"ManagerName\": \"toto\",\n \"Surface\": 35,\n \"DistanceFromSubway\": 1.5,\n \"Level\": \"one\",\n \"Services\": [\n \"DisabledAccess\",\n \"FreeParking\"\n ],\n \"BannerImage\": [\n \"image 1\",\n \"image 2\"\n ],\n \"TeamMembers\": [\n {\n \"url\": \"image1\",\n \"texts\": {\n \"name1\": \"value 1\",\n \"name2\": \"value 2\"\n }\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-APIKey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.partoo.co/v2/business")
.header("x-APIKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Corner shop\",\n \"country\": \"FR\",\n \"categories\": [\n \"gcid:restaurant\",\n \"gcid:fast_food_restaurant\",\n \"gcid:hamburger_restaurant\"\n ],\n \"contacts\": [\n {\n \"name\": \"Hubert Bonisseur de la Bath\",\n \"email\": \"hubert@oss117.fr\",\n \"phone_numbers\": [\n \"+33302060628\"\n ],\n \"fax\": \"+33302060629\"\n }\n ],\n \"org_id\": 42,\n \"groups\": [\n 1,\n 2,\n 3\n ],\n \"reach\": \"LOCAL\",\n \"zipcode\": \"75019\",\n \"city\": \"Paris\",\n \"region\": \"Ile-de-France\",\n \"code\": \"CS-75019\",\n \"status\": \"open\",\n \"opening_date\": \"2025-01-01\",\n \"address_full\": \"12 bis rue du coquelicot\",\n \"address2\": \"<string>\",\n \"lat\": -3.585993,\n \"long\": 47.870341,\n \"website_url\": \"https://www.corner-shop.co/\",\n \"facebook_url\": \"https://www.facebook.com/the-corner-shop\",\n \"twitter_url\": \"https://www.twitter.com/the-corner-shop\",\n \"description_short\": \"lorem ipsum\",\n \"description_long\": \"lorem ipsum dolor sit amet\",\n \"photos\": {\n \"LOGO\": \"<string>\",\n \"primary\": \"<string>\",\n \"secondary\": [\n \"<string>\"\n ]\n },\n \"national_identification_number\": \"<string>\",\n \"custom_fields\": {\n \"Parking\": true,\n \"ManagerName\": \"toto\",\n \"Surface\": 35,\n \"DistanceFromSubway\": 1.5,\n \"Level\": \"one\",\n \"Services\": [\n \"DisabledAccess\",\n \"FreeParking\"\n ],\n \"BannerImage\": [\n \"image 1\",\n \"image 2\"\n ],\n \"TeamMembers\": [\n {\n \"url\": \"image1\",\n \"texts\": {\n \"name1\": \"value 1\",\n \"name2\": \"value 2\"\n }\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.partoo.co/v2/business")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-APIKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Corner shop\",\n \"country\": \"FR\",\n \"categories\": [\n \"gcid:restaurant\",\n \"gcid:fast_food_restaurant\",\n \"gcid:hamburger_restaurant\"\n ],\n \"contacts\": [\n {\n \"name\": \"Hubert Bonisseur de la Bath\",\n \"email\": \"hubert@oss117.fr\",\n \"phone_numbers\": [\n \"+33302060628\"\n ],\n \"fax\": \"+33302060629\"\n }\n ],\n \"org_id\": 42,\n \"groups\": [\n 1,\n 2,\n 3\n ],\n \"reach\": \"LOCAL\",\n \"zipcode\": \"75019\",\n \"city\": \"Paris\",\n \"region\": \"Ile-de-France\",\n \"code\": \"CS-75019\",\n \"status\": \"open\",\n \"opening_date\": \"2025-01-01\",\n \"address_full\": \"12 bis rue du coquelicot\",\n \"address2\": \"<string>\",\n \"lat\": -3.585993,\n \"long\": 47.870341,\n \"website_url\": \"https://www.corner-shop.co/\",\n \"facebook_url\": \"https://www.facebook.com/the-corner-shop\",\n \"twitter_url\": \"https://www.twitter.com/the-corner-shop\",\n \"description_short\": \"lorem ipsum\",\n \"description_long\": \"lorem ipsum dolor sit amet\",\n \"photos\": {\n \"LOGO\": \"<string>\",\n \"primary\": \"<string>\",\n \"secondary\": [\n \"<string>\"\n ]\n },\n \"national_identification_number\": \"<string>\",\n \"custom_fields\": {\n \"Parking\": true,\n \"ManagerName\": \"toto\",\n \"Surface\": 35,\n \"DistanceFromSubway\": 1.5,\n \"Level\": \"one\",\n \"Services\": [\n \"DisabledAccess\",\n \"FreeParking\"\n ],\n \"BannerImage\": [\n \"image 1\",\n \"image 2\"\n ],\n \"TeamMembers\": [\n {\n \"url\": \"image1\",\n \"texts\": {\n \"name1\": \"value 1\",\n \"name2\": \"value 2\"\n }\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"id": "5409c35a97bbc544d8e26737"
}{
"errors": {
"json": {}
}
}{
"errors": {
"authentication": "User not authenticated"
}
}{
"errors": {
"authorization": "Operation not allowed"
}
}Businesses
Create business
This API allows the creation of a new business in the context of your organization.
POST
/
business
Create business
curl --request POST \
--url https://api.partoo.co/v2/business \
--header 'Content-Type: application/json' \
--header 'x-APIKey: <api-key>' \
--data '
{
"name": "Corner shop",
"country": "FR",
"categories": [
"gcid:restaurant",
"gcid:fast_food_restaurant",
"gcid:hamburger_restaurant"
],
"contacts": [
{
"name": "Hubert Bonisseur de la Bath",
"email": "hubert@oss117.fr",
"phone_numbers": [
"+33302060628"
],
"fax": "+33302060629"
}
],
"org_id": 42,
"groups": [
1,
2,
3
],
"reach": "LOCAL",
"zipcode": "75019",
"city": "Paris",
"region": "Ile-de-France",
"code": "CS-75019",
"status": "open",
"opening_date": "2025-01-01",
"address_full": "12 bis rue du coquelicot",
"address2": "<string>",
"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",
"photos": {
"LOGO": "<string>",
"primary": "<string>",
"secondary": [
"<string>"
]
},
"national_identification_number": "<string>",
"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"
}
}
]
}
}
'import requests
url = "https://api.partoo.co/v2/business"
payload = {
"name": "Corner shop",
"country": "FR",
"categories": ["gcid:restaurant", "gcid:fast_food_restaurant", "gcid:hamburger_restaurant"],
"contacts": [
{
"name": "Hubert Bonisseur de la Bath",
"email": "hubert@oss117.fr",
"phone_numbers": ["+33302060628"],
"fax": "+33302060629"
}
],
"org_id": 42,
"groups": [1, 2, 3],
"reach": "LOCAL",
"zipcode": "75019",
"city": "Paris",
"region": "Ile-de-France",
"code": "CS-75019",
"status": "open",
"opening_date": "2025-01-01",
"address_full": "12 bis rue du coquelicot",
"address2": "<string>",
"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",
"photos": {
"LOGO": "<string>",
"primary": "<string>",
"secondary": ["<string>"]
},
"national_identification_number": "<string>",
"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"
}
}
]
}
}
headers = {
"x-APIKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-APIKey': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Corner shop',
country: 'FR',
categories: ['gcid:restaurant', 'gcid:fast_food_restaurant', 'gcid:hamburger_restaurant'],
contacts: [
{
name: 'Hubert Bonisseur de la Bath',
email: 'hubert@oss117.fr',
phone_numbers: ['+33302060628'],
fax: '+33302060629'
}
],
org_id: 42,
groups: [1, 2, 3],
reach: 'LOCAL',
zipcode: '75019',
city: 'Paris',
region: 'Ile-de-France',
code: 'CS-75019',
status: 'open',
opening_date: '2025-01-01',
address_full: '12 bis rue du coquelicot',
address2: '<string>',
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',
photos: {LOGO: '<string>', primary: '<string>', secondary: ['<string>']},
national_identification_number: '<string>',
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'}}]
}
})
};
fetch('https://api.partoo.co/v2/business', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.partoo.co/v2/business",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Corner shop',
'country' => 'FR',
'categories' => [
'gcid:restaurant',
'gcid:fast_food_restaurant',
'gcid:hamburger_restaurant'
],
'contacts' => [
[
'name' => 'Hubert Bonisseur de la Bath',
'email' => 'hubert@oss117.fr',
'phone_numbers' => [
'+33302060628'
],
'fax' => '+33302060629'
]
],
'org_id' => 42,
'groups' => [
1,
2,
3
],
'reach' => 'LOCAL',
'zipcode' => '75019',
'city' => 'Paris',
'region' => 'Ile-de-France',
'code' => 'CS-75019',
'status' => 'open',
'opening_date' => '2025-01-01',
'address_full' => '12 bis rue du coquelicot',
'address2' => '<string>',
'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',
'photos' => [
'LOGO' => '<string>',
'primary' => '<string>',
'secondary' => [
'<string>'
]
],
'national_identification_number' => '<string>',
'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'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-APIKey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.partoo.co/v2/business"
payload := strings.NewReader("{\n \"name\": \"Corner shop\",\n \"country\": \"FR\",\n \"categories\": [\n \"gcid:restaurant\",\n \"gcid:fast_food_restaurant\",\n \"gcid:hamburger_restaurant\"\n ],\n \"contacts\": [\n {\n \"name\": \"Hubert Bonisseur de la Bath\",\n \"email\": \"hubert@oss117.fr\",\n \"phone_numbers\": [\n \"+33302060628\"\n ],\n \"fax\": \"+33302060629\"\n }\n ],\n \"org_id\": 42,\n \"groups\": [\n 1,\n 2,\n 3\n ],\n \"reach\": \"LOCAL\",\n \"zipcode\": \"75019\",\n \"city\": \"Paris\",\n \"region\": \"Ile-de-France\",\n \"code\": \"CS-75019\",\n \"status\": \"open\",\n \"opening_date\": \"2025-01-01\",\n \"address_full\": \"12 bis rue du coquelicot\",\n \"address2\": \"<string>\",\n \"lat\": -3.585993,\n \"long\": 47.870341,\n \"website_url\": \"https://www.corner-shop.co/\",\n \"facebook_url\": \"https://www.facebook.com/the-corner-shop\",\n \"twitter_url\": \"https://www.twitter.com/the-corner-shop\",\n \"description_short\": \"lorem ipsum\",\n \"description_long\": \"lorem ipsum dolor sit amet\",\n \"photos\": {\n \"LOGO\": \"<string>\",\n \"primary\": \"<string>\",\n \"secondary\": [\n \"<string>\"\n ]\n },\n \"national_identification_number\": \"<string>\",\n \"custom_fields\": {\n \"Parking\": true,\n \"ManagerName\": \"toto\",\n \"Surface\": 35,\n \"DistanceFromSubway\": 1.5,\n \"Level\": \"one\",\n \"Services\": [\n \"DisabledAccess\",\n \"FreeParking\"\n ],\n \"BannerImage\": [\n \"image 1\",\n \"image 2\"\n ],\n \"TeamMembers\": [\n {\n \"url\": \"image1\",\n \"texts\": {\n \"name1\": \"value 1\",\n \"name2\": \"value 2\"\n }\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-APIKey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.partoo.co/v2/business")
.header("x-APIKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Corner shop\",\n \"country\": \"FR\",\n \"categories\": [\n \"gcid:restaurant\",\n \"gcid:fast_food_restaurant\",\n \"gcid:hamburger_restaurant\"\n ],\n \"contacts\": [\n {\n \"name\": \"Hubert Bonisseur de la Bath\",\n \"email\": \"hubert@oss117.fr\",\n \"phone_numbers\": [\n \"+33302060628\"\n ],\n \"fax\": \"+33302060629\"\n }\n ],\n \"org_id\": 42,\n \"groups\": [\n 1,\n 2,\n 3\n ],\n \"reach\": \"LOCAL\",\n \"zipcode\": \"75019\",\n \"city\": \"Paris\",\n \"region\": \"Ile-de-France\",\n \"code\": \"CS-75019\",\n \"status\": \"open\",\n \"opening_date\": \"2025-01-01\",\n \"address_full\": \"12 bis rue du coquelicot\",\n \"address2\": \"<string>\",\n \"lat\": -3.585993,\n \"long\": 47.870341,\n \"website_url\": \"https://www.corner-shop.co/\",\n \"facebook_url\": \"https://www.facebook.com/the-corner-shop\",\n \"twitter_url\": \"https://www.twitter.com/the-corner-shop\",\n \"description_short\": \"lorem ipsum\",\n \"description_long\": \"lorem ipsum dolor sit amet\",\n \"photos\": {\n \"LOGO\": \"<string>\",\n \"primary\": \"<string>\",\n \"secondary\": [\n \"<string>\"\n ]\n },\n \"national_identification_number\": \"<string>\",\n \"custom_fields\": {\n \"Parking\": true,\n \"ManagerName\": \"toto\",\n \"Surface\": 35,\n \"DistanceFromSubway\": 1.5,\n \"Level\": \"one\",\n \"Services\": [\n \"DisabledAccess\",\n \"FreeParking\"\n ],\n \"BannerImage\": [\n \"image 1\",\n \"image 2\"\n ],\n \"TeamMembers\": [\n {\n \"url\": \"image1\",\n \"texts\": {\n \"name1\": \"value 1\",\n \"name2\": \"value 2\"\n }\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.partoo.co/v2/business")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-APIKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Corner shop\",\n \"country\": \"FR\",\n \"categories\": [\n \"gcid:restaurant\",\n \"gcid:fast_food_restaurant\",\n \"gcid:hamburger_restaurant\"\n ],\n \"contacts\": [\n {\n \"name\": \"Hubert Bonisseur de la Bath\",\n \"email\": \"hubert@oss117.fr\",\n \"phone_numbers\": [\n \"+33302060628\"\n ],\n \"fax\": \"+33302060629\"\n }\n ],\n \"org_id\": 42,\n \"groups\": [\n 1,\n 2,\n 3\n ],\n \"reach\": \"LOCAL\",\n \"zipcode\": \"75019\",\n \"city\": \"Paris\",\n \"region\": \"Ile-de-France\",\n \"code\": \"CS-75019\",\n \"status\": \"open\",\n \"opening_date\": \"2025-01-01\",\n \"address_full\": \"12 bis rue du coquelicot\",\n \"address2\": \"<string>\",\n \"lat\": -3.585993,\n \"long\": 47.870341,\n \"website_url\": \"https://www.corner-shop.co/\",\n \"facebook_url\": \"https://www.facebook.com/the-corner-shop\",\n \"twitter_url\": \"https://www.twitter.com/the-corner-shop\",\n \"description_short\": \"lorem ipsum\",\n \"description_long\": \"lorem ipsum dolor sit amet\",\n \"photos\": {\n \"LOGO\": \"<string>\",\n \"primary\": \"<string>\",\n \"secondary\": [\n \"<string>\"\n ]\n },\n \"national_identification_number\": \"<string>\",\n \"custom_fields\": {\n \"Parking\": true,\n \"ManagerName\": \"toto\",\n \"Surface\": 35,\n \"DistanceFromSubway\": 1.5,\n \"Level\": \"one\",\n \"Services\": [\n \"DisabledAccess\",\n \"FreeParking\"\n ],\n \"BannerImage\": [\n \"image 1\",\n \"image 2\"\n ],\n \"TeamMembers\": [\n {\n \"url\": \"image1\",\n \"texts\": {\n \"name1\": \"value 1\",\n \"name2\": \"value 2\"\n }\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"id": "5409c35a97bbc544d8e26737"
}{
"errors": {
"json": {}
}
}{
"errors": {
"authentication": "User not authenticated"
}
}{
"errors": {
"authorization": "Operation not allowed"
}
}Authorizations
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.
Body
application/json
Request object
The name of the business (POI) as it will appear on the publishing platforms
Minimum string length:
1Example:
"Corner shop"
Business country - In the ISO 3166 alpha2 code format (i.e. use āFRā for France instead of "fr")
Example:
"FR"
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:
1Example:
[ "gcid:restaurant", "gcid:fast_food_restaurant", "gcid:hamburger_restaurant" ]
Specify how the clients can reach the persons in charge of the business in case they have questions.
Show child attributes
Show child attributes
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.
Example:
42
List of Group ID of the business.
Groups the business belongs to.
Example:
[1, 2, 3]
Defines whether the business is a physical entity with an address (LOCAL) or a Brand (GLOBAL).
Available options:
LOCAL, GLOBAL Example:
"LOCAL"
Zipcode (or postal code) for the business address. Can be empty if the business' country does not require one.
Example:
"75019"
The city where the business is located.
Required if 'reach' is not specified or set to 'LOCAL'.
Example:
"Paris"
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"
The unique store code of the business. If not provided, it will be automatically generated
Example:
"CS-75019"
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"
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"
Full address of the business.
For example : 130 Rue du Mont-Cenis.
Example:
"12 bis rue du coquelicot"
Complement of address. Any additional information that could help better find the business location
Latitude. Decimals are separated by a dot and not by a comma.
Example:
-3.585993
Longitude. Decimals are separated by a dot and not by a comma.
Example:
47.870341
The business own website url or the main url of the company.
Example:
"https://www.corner-shop.co/"
Business Facebook page url
Example:
"https://www.facebook.com/the-corner-shop"
Business twitter page url
Example:
"https://www.twitter.com/the-corner-shop"
A short description of the business.
ā ļø It is limited to 80 characters
Example:
"lorem ipsum"
A more detailed description of the business.
ā ļø It is limited to 750 characters
Example:
"lorem ipsum dolor sit amet"
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.
Show child attributes
Show child attributes
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 hoursclose, containing a list of days where the business is exceptionally closed all day
These values in turn contain:
starts_atindicating the first date for which the exceptional hours are validends_atindicating the last date (inclusive) for which the exceptional hours are validopen_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 inopen_hours
Show child attributes
Show child attributes
Business photos
Each business can have one or more photos associated
Show child attributes
Show child attributes
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 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.
Show child attributes
Show child attributes
Example:
{ "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" } } ] }
Was this page helpful?