Skip to main content
POST
/
custom_fields
/
order
Order custom fields
curl --request POST \
  --url https://api.partoo.co/v2/custom_fields/order \
  --header 'Content-Type: application/json' \
  --header 'x-APIKey: <api-key>' \
  --data '
{
  "orders": [
    {
      "id": 42,
      "order": 30,
      "section_id": 6
    }
  ],
  "section_orders": [
    {
      "id": 6,
      "order": 18
    }
  ]
}
'
import requests

url = "https://api.partoo.co/v2/custom_fields/order"

payload = {
    "orders": [
        {
            "id": 42,
            "order": 30,
            "section_id": 6
        }
    ],
    "section_orders": [
        {
            "id": 6,
            "order": 18
        }
    ]
}
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({
    orders: [{id: 42, order: 30, section_id: 6}],
    section_orders: [{id: 6, order: 18}]
  })
};

fetch('https://api.partoo.co/v2/custom_fields/order', 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/custom_fields/order",
  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([
    'orders' => [
        [
                'id' => 42,
                'order' => 30,
                'section_id' => 6
        ]
    ],
    'section_orders' => [
        [
                'id' => 6,
                'order' => 18
        ]
    ]
  ]),
  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/custom_fields/order"

	payload := strings.NewReader("{\n  \"orders\": [\n    {\n      \"id\": 42,\n      \"order\": 30,\n      \"section_id\": 6\n    }\n  ],\n  \"section_orders\": [\n    {\n      \"id\": 6,\n      \"order\": 18\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/custom_fields/order")
  .header("x-APIKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"orders\": [\n    {\n      \"id\": 42,\n      \"order\": 30,\n      \"section_id\": 6\n    }\n  ],\n  \"section_orders\": [\n    {\n      \"id\": 6,\n      \"order\": 18\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.partoo.co/v2/custom_fields/order")

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  \"orders\": [\n    {\n      \"id\": 42,\n      \"order\": 30,\n      \"section_id\": 6\n    }\n  ],\n  \"section_orders\": [\n    {\n      \"id\": 6,\n      \"order\": 18\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success"
}
{
  "errors": {
    "authentication": "User not authenticated"
  }
}
{
  "errors": {
    "authorization": "Operation not allowed"
  }
}
{
  "errors": {
    "json": "Resource not found"
  }
}

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.

Query Parameters

org_id
integer

Organization ID. Only PROVIDER users can specify a different organization. If not provided, defaults to your own organization.

Body

application/json

Request object to reorder custom fields and optionally sections

orders
object[]
required

On the Business Edit view of the Partoo App, custom fields will be displayed depending on their order.
The lowest number will be the first.

section_orders
object[]

On the Business Edit view of the Partoo App, custom fields section will be displayed depending on their order.
The lowest number will be the first.

Response

OK

status
enum<string>

Request status

Available options:
success