curl --request POST \
--url https://api.partoo.co/v2/org \
--header 'Content-Type: application/json' \
--header 'x-APIKey: <api-key>' \
--data '
{
"name": "Fast Retailer",
"alias": "fast_retailer",
"max_businesses": 100
}
'import requests
url = "https://api.partoo.co/v2/org"
payload = {
"name": "Fast Retailer",
"alias": "fast_retailer",
"max_businesses": 100
}
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: 'Fast Retailer', alias: 'fast_retailer', max_businesses: 100})
};
fetch('https://api.partoo.co/v2/org', 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/org",
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' => 'Fast Retailer',
'alias' => 'fast_retailer',
'max_businesses' => 100
]),
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/org"
payload := strings.NewReader("{\n \"name\": \"Fast Retailer\",\n \"alias\": \"fast_retailer\",\n \"max_businesses\": 100\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/org")
.header("x-APIKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Fast Retailer\",\n \"alias\": \"fast_retailer\",\n \"max_businesses\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.partoo.co/v2/org")
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\": \"Fast Retailer\",\n \"alias\": \"fast_retailer\",\n \"max_businesses\": 100\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"org_id": 42,
"alias": "fast_retailer",
"max_businesses": 100
}{
"errors": {
"json": {}
}
}{
"errors": {
"authentication": "User not authenticated"
}
}{
"errors": {
"authorization": "Operation not allowed"
}
}Create organization
This endpoint lets you create an organization. You have WRITE access on your provider (ie. only possible if you have PROVIDER role).
curl --request POST \
--url https://api.partoo.co/v2/org \
--header 'Content-Type: application/json' \
--header 'x-APIKey: <api-key>' \
--data '
{
"name": "Fast Retailer",
"alias": "fast_retailer",
"max_businesses": 100
}
'import requests
url = "https://api.partoo.co/v2/org"
payload = {
"name": "Fast Retailer",
"alias": "fast_retailer",
"max_businesses": 100
}
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: 'Fast Retailer', alias: 'fast_retailer', max_businesses: 100})
};
fetch('https://api.partoo.co/v2/org', 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/org",
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' => 'Fast Retailer',
'alias' => 'fast_retailer',
'max_businesses' => 100
]),
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/org"
payload := strings.NewReader("{\n \"name\": \"Fast Retailer\",\n \"alias\": \"fast_retailer\",\n \"max_businesses\": 100\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/org")
.header("x-APIKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Fast Retailer\",\n \"alias\": \"fast_retailer\",\n \"max_businesses\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.partoo.co/v2/org")
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\": \"Fast Retailer\",\n \"alias\": \"fast_retailer\",\n \"max_businesses\": 100\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"org_id": 42,
"alias": "fast_retailer",
"max_businesses": 100
}{
"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
JSON to create an organization
Organization name
"Fast Retailer"
Organization alias (should match regex [a-z0-9_])
"fast_retailer"
Maximum number of local businesses the organization can have.
It does not include the global (brand) businesses.
If null, there is no limit for the organization.
This field can only be set by a PROVIDER user.
100
Response
OK
Result object
Request status
success Unique identifier of an organization in Partoo.
42
Organization alias (should match regex [a-z0-9_])
"fast_retailer"
Maximum number of local businesses the organization can have.
It does not include the global (brand) businesses.
If null, there is no limit for the organization.
This field can only be set by a PROVIDER user.
100
Was this page helpful?