Tenant credential
curl --request POST 'https://api.printools.io/v1/custom-fields' \
--header 'X-API-Key: $PRINTOOLS_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"name":"Artwork approval","type":"select","options":["Pending","Approved"]}'import requests
url = "https://api.printools.io/v1/custom-fields"
payload = {
"name": "Artwork approval",
"type": "select",
"options": ["Pending", "Approved"]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Artwork approval', type: 'select', options: ['Pending', 'Approved']})
};
fetch('https://api.printools.io/v1/custom-fields', 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.printools.io/v1/custom-fields",
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' => 'Artwork approval',
'type' => 'select',
'options' => [
'Pending',
'Approved'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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.printools.io/v1/custom-fields"
payload := strings.NewReader("{\n \"name\": \"Artwork approval\",\n \"type\": \"select\",\n \"options\": [\n \"Pending\",\n \"Approved\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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.printools.io/v1/custom-fields")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Artwork approval\",\n \"type\": \"select\",\n \"options\": [\n \"Pending\",\n \"Approved\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.printools.io/v1/custom-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Artwork approval\",\n \"type\": \"select\",\n \"options\": [\n \"Pending\",\n \"Approved\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "OK",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "text",
"entity": "job",
"options": [
"<unknown>"
]
}
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}Custom fields & statuses
Create a custom field definition
Requires the scope customfields.write.
POST
/
v1
/
custom-fields
Tenant credential
curl --request POST 'https://api.printools.io/v1/custom-fields' \
--header 'X-API-Key: $PRINTOOLS_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"name":"Artwork approval","type":"select","options":["Pending","Approved"]}'import requests
url = "https://api.printools.io/v1/custom-fields"
payload = {
"name": "Artwork approval",
"type": "select",
"options": ["Pending", "Approved"]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Artwork approval', type: 'select', options: ['Pending', 'Approved']})
};
fetch('https://api.printools.io/v1/custom-fields', 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.printools.io/v1/custom-fields",
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' => 'Artwork approval',
'type' => 'select',
'options' => [
'Pending',
'Approved'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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.printools.io/v1/custom-fields"
payload := strings.NewReader("{\n \"name\": \"Artwork approval\",\n \"type\": \"select\",\n \"options\": [\n \"Pending\",\n \"Approved\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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.printools.io/v1/custom-fields")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Artwork approval\",\n \"type\": \"select\",\n \"options\": [\n \"Pending\",\n \"Approved\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.printools.io/v1/custom-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Artwork approval\",\n \"type\": \"select\",\n \"options\": [\n \"Pending\",\n \"Approved\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "OK",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "text",
"entity": "job",
"options": [
"<unknown>"
]
}
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}Required scopes:
customfields.write.Authorizations
tenantApiKeypartnerApiKey & partnerApiSecret & partnerBearer
Tenant credential. This is sufficient by itself.
Headers
Tenant credential: optional and, when sent, must equal the shop bound to the key. Partner credential: required; it selects an organisation the user previously authorised.
Optional client-generated key for write retries. Reusing it with a different request returns 409; a replay includes Idempotency-Replayed: true.
Required string length:
1 - 200Body
application/json
Was this page helpful?

