Tenant credential
curl --request PATCH 'https://api.printools.io/v1/jobs/11111111-2222-3333-4444-555555555555' \
--header 'X-API-Key: $PRINTOOLS_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"jobRef":"example","jobName":"example","status":"example","contactId":"example","salesRepEmail":"example"}'import requests
url = "https://api.printools.io/v1/jobs/{jobId}"
payload = {
"jobRef": "example",
"jobName": "example",
"status": "example",
"contactId": "example",
"salesRepEmail": "example"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
jobRef: 'example',
jobName: 'example',
status: 'example',
contactId: 'example',
salesRepEmail: 'example'
})
};
fetch('https://api.printools.io/v1/jobs/{jobId}', 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/jobs/{jobId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'jobRef' => 'example',
'jobName' => 'example',
'status' => 'example',
'contactId' => 'example',
'salesRepEmail' => '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/jobs/{jobId}"
payload := strings.NewReader("{\n \"jobRef\": \"example\",\n \"jobName\": \"example\",\n \"status\": \"example\",\n \"contactId\": \"example\",\n \"salesRepEmail\": \"example\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.printools.io/v1/jobs/{jobId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"jobRef\": \"example\",\n \"jobName\": \"example\",\n \"status\": \"example\",\n \"contactId\": \"example\",\n \"salesRepEmail\": \"example\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.printools.io/v1/jobs/{jobId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"jobRef\": \"example\",\n \"jobName\": \"example\",\n \"status\": \"example\",\n \"contactId\": \"example\",\n \"salesRepEmail\": \"example\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "OK",
"data": {
"id": "<string>",
"status": "<string>",
"priority": "Normal",
"invoiceStatus": "<string>",
"quoteOutOfSync": true,
"totalQuantity": 123,
"poStatus": "NotCreated",
"materialsStatus": "NotPurchased",
"estimatedDuration": 123,
"customFieldValues": "<unknown>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"groups": [
{
"id": "<string>",
"jobId": "<string>",
"name": "<string>",
"totalQuantity": 123,
"sortOrder": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"lines": [
{
"id": "<string>",
"jobGroupId": "<string>",
"lineType": "Garment",
"productName": "<string>",
"quantity": 123,
"unitPriceExGst": 123,
"sortOrder": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"variants": [
{
"id": "<string>",
"jobLineId": "<string>",
"quantity": 123,
"producedQuantity": 123,
"unitPriceExGst": 123,
"sortOrder": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"size": "<string>",
"colour": "<string>",
"buyPrice": 123,
"extraCost": 123
}
],
"garmentCatalogueItemId": "<string>",
"productSku": "<string>",
"title": "<string>",
"description": "<string>",
"customImageUrl": "<string>"
}
],
"decorations": [
{
"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>"
}
],
"notes": "<string>"
}
],
"activity": [
{
"id": "<string>",
"jobId": "<string>",
"activityType": "<string>",
"title": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"taskId": "<string>",
"description": "<string>",
"performedBy": "<string>",
"editedAt": "2023-11-07T05:31:56Z"
}
],
"jobRef": "<string>",
"jobName": "<string>",
"quoteId": "<string>",
"quoteRef": "<string>",
"customerId": "<string>",
"contactId": "<string>",
"salesRepEmail": "<string>",
"reference": "<string>",
"shipPickupDate": "2023-12-25",
"productionDeadline": "2023-12-25",
"deliveryMethod": "<string>",
"shippingBranding": "<string>",
"shippingAddressId": "<string>",
"paymentType": "<string>",
"lastQuoteSyncDate": "2023-11-07T05:31:56Z",
"scheduledStartDate": "2023-12-25",
"scheduledEndDate": "2023-12-25",
"jobNotes": "<string>",
"clientNotes": "<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
Update a job
Requires the scope jobs.write.
PATCH
/
v1
/
jobs
/
{jobId}
Tenant credential
curl --request PATCH 'https://api.printools.io/v1/jobs/11111111-2222-3333-4444-555555555555' \
--header 'X-API-Key: $PRINTOOLS_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"jobRef":"example","jobName":"example","status":"example","contactId":"example","salesRepEmail":"example"}'import requests
url = "https://api.printools.io/v1/jobs/{jobId}"
payload = {
"jobRef": "example",
"jobName": "example",
"status": "example",
"contactId": "example",
"salesRepEmail": "example"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
jobRef: 'example',
jobName: 'example',
status: 'example',
contactId: 'example',
salesRepEmail: 'example'
})
};
fetch('https://api.printools.io/v1/jobs/{jobId}', 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/jobs/{jobId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'jobRef' => 'example',
'jobName' => 'example',
'status' => 'example',
'contactId' => 'example',
'salesRepEmail' => '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/jobs/{jobId}"
payload := strings.NewReader("{\n \"jobRef\": \"example\",\n \"jobName\": \"example\",\n \"status\": \"example\",\n \"contactId\": \"example\",\n \"salesRepEmail\": \"example\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.printools.io/v1/jobs/{jobId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"jobRef\": \"example\",\n \"jobName\": \"example\",\n \"status\": \"example\",\n \"contactId\": \"example\",\n \"salesRepEmail\": \"example\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.printools.io/v1/jobs/{jobId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"jobRef\": \"example\",\n \"jobName\": \"example\",\n \"status\": \"example\",\n \"contactId\": \"example\",\n \"salesRepEmail\": \"example\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "OK",
"data": {
"id": "<string>",
"status": "<string>",
"priority": "Normal",
"invoiceStatus": "<string>",
"quoteOutOfSync": true,
"totalQuantity": 123,
"poStatus": "NotCreated",
"materialsStatus": "NotPurchased",
"estimatedDuration": 123,
"customFieldValues": "<unknown>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"groups": [
{
"id": "<string>",
"jobId": "<string>",
"name": "<string>",
"totalQuantity": 123,
"sortOrder": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"lines": [
{
"id": "<string>",
"jobGroupId": "<string>",
"lineType": "Garment",
"productName": "<string>",
"quantity": 123,
"unitPriceExGst": 123,
"sortOrder": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"variants": [
{
"id": "<string>",
"jobLineId": "<string>",
"quantity": 123,
"producedQuantity": 123,
"unitPriceExGst": 123,
"sortOrder": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"size": "<string>",
"colour": "<string>",
"buyPrice": 123,
"extraCost": 123
}
],
"garmentCatalogueItemId": "<string>",
"productSku": "<string>",
"title": "<string>",
"description": "<string>",
"customImageUrl": "<string>"
}
],
"decorations": [
{
"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>"
}
],
"notes": "<string>"
}
],
"activity": [
{
"id": "<string>",
"jobId": "<string>",
"activityType": "<string>",
"title": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"taskId": "<string>",
"description": "<string>",
"performedBy": "<string>",
"editedAt": "2023-11-07T05:31:56Z"
}
],
"jobRef": "<string>",
"jobName": "<string>",
"quoteId": "<string>",
"quoteRef": "<string>",
"customerId": "<string>",
"contactId": "<string>",
"salesRepEmail": "<string>",
"reference": "<string>",
"shipPickupDate": "2023-12-25",
"productionDeadline": "2023-12-25",
"deliveryMethod": "<string>",
"shippingBranding": "<string>",
"shippingAddressId": "<string>",
"paymentType": "<string>",
"lastQuoteSyncDate": "2023-11-07T05:31:56Z",
"scheduledStartDate": "2023-12-25",
"scheduledEndDate": "2023-12-25",
"jobNotes": "<string>",
"clientNotes": "<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:
Normal, Rush Arbitrary JSON. Its structure is application-defined and is intentionally not presented as a closed object.
Was this page helpful?

