Tenant credential
curl --request POST 'https://api.printools.io/v1/job-groups/11111111-2222-3333-4444-555555555555/decorations' \
--header 'X-API-Key: $PRINTOOLS_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"jobGroupId":"example","decorationItemId":"example","method":"ScreenPrinting","position":"example","quantity":1,"description":"example"}'import requests
url = "https://api.printools.io/v1/job-groups/{groupId}/decorations"
payload = {
"jobGroupId": "example",
"decorationItemId": "example",
"method": "ScreenPrinting",
"position": "example",
"quantity": 1,
"description": "example"
}
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({
jobGroupId: 'example',
decorationItemId: 'example',
method: 'ScreenPrinting',
position: 'example',
quantity: 1,
description: 'example'
})
};
fetch('https://api.printools.io/v1/job-groups/{groupId}/decorations', 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/job-groups/{groupId}/decorations",
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([
'jobGroupId' => 'example',
'decorationItemId' => 'example',
'method' => 'ScreenPrinting',
'position' => 'example',
'quantity' => 1,
'description' => 'example'
]),
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/job-groups/{groupId}/decorations"
payload := strings.NewReader("{\n \"jobGroupId\": \"example\",\n \"decorationItemId\": \"example\",\n \"method\": \"ScreenPrinting\",\n \"position\": \"example\",\n \"quantity\": 1,\n \"description\": \"example\"\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/job-groups/{groupId}/decorations")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"jobGroupId\": \"example\",\n \"decorationItemId\": \"example\",\n \"method\": \"ScreenPrinting\",\n \"position\": \"example\",\n \"quantity\": 1,\n \"description\": \"example\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.printools.io/v1/job-groups/{groupId}/decorations")
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 \"jobGroupId\": \"example\",\n \"decorationItemId\": \"example\",\n \"method\": \"ScreenPrinting\",\n \"position\": \"example\",\n \"quantity\": 1,\n \"description\": \"example\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "OK",
"data": {
"id": "<string>",
"jobGroupId": "<string>",
"colours": [
{
"name": "<string>",
"isBase": true
}
],
"baseUnitCost": 123,
"baseSetupCost": 123,
"includeSetupCost": true,
"sortOrder": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"decorationItemId": "<string>",
"method": "ScreenPrinting",
"position": "<string>",
"quantity": 123,
"description": "<string>",
"screenCount": 123,
"screenMeshGrade": "<string>",
"colourCount": 123,
"setupCost": 123,
"unitCost": 123,
"widthCm": 123,
"lengthCm": 123,
"necklineDropCm": 123,
"specialInstructions": "<string>",
"artworkFileUrl": "<string>",
"separationFileUrl": "<string>"
}
}{
"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
}Jobs
Attach a decoration to a job group
Requires the scope jobs.write.
POST
/
v1
/
job-groups
/
{groupId}
/
decorations
Tenant credential
curl --request POST 'https://api.printools.io/v1/job-groups/11111111-2222-3333-4444-555555555555/decorations' \
--header 'X-API-Key: $PRINTOOLS_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"jobGroupId":"example","decorationItemId":"example","method":"ScreenPrinting","position":"example","quantity":1,"description":"example"}'import requests
url = "https://api.printools.io/v1/job-groups/{groupId}/decorations"
payload = {
"jobGroupId": "example",
"decorationItemId": "example",
"method": "ScreenPrinting",
"position": "example",
"quantity": 1,
"description": "example"
}
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({
jobGroupId: 'example',
decorationItemId: 'example',
method: 'ScreenPrinting',
position: 'example',
quantity: 1,
description: 'example'
})
};
fetch('https://api.printools.io/v1/job-groups/{groupId}/decorations', 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/job-groups/{groupId}/decorations",
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([
'jobGroupId' => 'example',
'decorationItemId' => 'example',
'method' => 'ScreenPrinting',
'position' => 'example',
'quantity' => 1,
'description' => 'example'
]),
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/job-groups/{groupId}/decorations"
payload := strings.NewReader("{\n \"jobGroupId\": \"example\",\n \"decorationItemId\": \"example\",\n \"method\": \"ScreenPrinting\",\n \"position\": \"example\",\n \"quantity\": 1,\n \"description\": \"example\"\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/job-groups/{groupId}/decorations")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"jobGroupId\": \"example\",\n \"decorationItemId\": \"example\",\n \"method\": \"ScreenPrinting\",\n \"position\": \"example\",\n \"quantity\": 1,\n \"description\": \"example\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.printools.io/v1/job-groups/{groupId}/decorations")
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 \"jobGroupId\": \"example\",\n \"decorationItemId\": \"example\",\n \"method\": \"ScreenPrinting\",\n \"position\": \"example\",\n \"quantity\": 1,\n \"description\": \"example\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "OK",
"data": {
"id": "<string>",
"jobGroupId": "<string>",
"colours": [
{
"name": "<string>",
"isBase": true
}
],
"baseUnitCost": 123,
"baseSetupCost": 123,
"includeSetupCost": true,
"sortOrder": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"decorationItemId": "<string>",
"method": "ScreenPrinting",
"position": "<string>",
"quantity": 123,
"description": "<string>",
"screenCount": 123,
"screenMeshGrade": "<string>",
"colourCount": 123,
"setupCost": 123,
"unitCost": 123,
"widthCm": 123,
"lengthCm": 123,
"necklineDropCm": 123,
"specialInstructions": "<string>",
"artworkFileUrl": "<string>",
"separationFileUrl": "<string>"
}
}{
"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:
jobs.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 - 200Path Parameters
UUID.
Example:
"11111111-2222-3333-4444-555555555555"
Body
application/json
Available options:
ScreenPrinting, Embroidery, DtfTransfer, Dtg, Vinyl, Sublimation, HeatTransfer, Outsourced, Other Replaces the whole list. At most one entry keeps isBase — see DecorationColour.
Show child attributes
Show child attributes
Centimetres — see JobGroupDecoration.widthCm.
Was this page helpful?

