Tenant credential
curl --request PUT 'https://api.printools.io/v1/prebuilt-items/11111111-2222-3333-4444-555555555555' \
--header 'X-API-Key: $PRINTOOLS_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"name":"example","description":"example","status":"draft","notes":"example","thumbnailUrl":"example","tags":["example"]}'import requests
url = "https://api.printools.io/v1/prebuilt-items/{itemId}"
payload = {
"name": "example",
"description": "example",
"status": "draft",
"notes": "example",
"thumbnailUrl": "example",
"tags": ["example"]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'example',
description: 'example',
status: 'draft',
notes: 'example',
thumbnailUrl: 'example',
tags: ['example']
})
};
fetch('https://api.printools.io/v1/prebuilt-items/{itemId}', 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/prebuilt-items/{itemId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'example',
'description' => 'example',
'status' => 'draft',
'notes' => 'example',
'thumbnailUrl' => 'example',
'tags' => [
'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/prebuilt-items/{itemId}"
payload := strings.NewReader("{\n \"name\": \"example\",\n \"description\": \"example\",\n \"status\": \"draft\",\n \"notes\": \"example\",\n \"thumbnailUrl\": \"example\",\n \"tags\": [\n \"example\"\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.printools.io/v1/prebuilt-items/{itemId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"example\",\n \"description\": \"example\",\n \"status\": \"draft\",\n \"notes\": \"example\",\n \"thumbnailUrl\": \"example\",\n \"tags\": [\n \"example\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.printools.io/v1/prebuilt-items/{itemId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"example\",\n \"description\": \"example\",\n \"status\": \"draft\",\n \"notes\": \"example\",\n \"thumbnailUrl\": \"example\",\n \"tags\": [\n \"example\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "OK",
"data": {
"id": "<string>",
"name": "<string>",
"status": "draft",
"tags": [
"<string>"
],
"computedUnitPriceExGst": 123,
"computedTotalQuantity": 123,
"totalQuantity": 123,
"lines": [
{
"id": "<string>",
"preBuiltItemId": "<string>",
"lineType": "garment",
"quantity": 123,
"unitPriceExGst": 123,
"sortOrder": 123,
"garmentCatalogueItemId": "<string>",
"productName": "<string>",
"productSku": "<string>",
"title": "<string>",
"description": "<string>",
"valueType": "Flat",
"percentage": 123,
"customImageUrl": "<string>"
}
],
"variants": [
{
"id": "<string>",
"preBuiltItemLineId": "<string>",
"quantity": 123,
"markupType": "percentage",
"markupValue": 123,
"markupSource": "group",
"unitPriceExGst": 123,
"sortOrder": 123,
"isCustomLine": true,
"showOnDocuments": true,
"size": "<string>",
"colour": "<string>",
"buyPrice": 123,
"extraCost": 123
}
],
"decorations": [
{
"id": "<string>",
"preBuiltItemId": "<string>",
"quantity": 123,
"includeSetupCost": true,
"markupType": "percentage",
"markupValue": 123,
"markupSource": "group",
"colours": [
{
"name": "<string>",
"isBase": true
}
],
"rollUp": true,
"rollUpSetup": true,
"showOnDocuments": true,
"sortOrder": 123,
"decorationItemId": "<string>",
"method": "<string>",
"name": "<string>",
"description": "<string>",
"position": "<string>",
"unitCost": 123,
"setupCost": 123,
"baseUnitCost": 123,
"baseSetupCost": 123,
"notes": "<string>",
"widthCm": 123,
"lengthCm": 123,
"necklineDropCm": 123,
"screenCount": 123,
"screenMeshGrade": "<string>",
"colourCount": 123,
"specialInstructions": "<string>",
"artworkFileUrl": "<string>",
"separationFileUrl": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"notes": "<string>",
"thumbnailUrl": "<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
}Pre-built items
Create or replace a pre-built item
Requires the scope prebuiltitems.write.
PUT
/
v1
/
prebuilt-items
/
{itemId}
Tenant credential
curl --request PUT 'https://api.printools.io/v1/prebuilt-items/11111111-2222-3333-4444-555555555555' \
--header 'X-API-Key: $PRINTOOLS_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"name":"example","description":"example","status":"draft","notes":"example","thumbnailUrl":"example","tags":["example"]}'import requests
url = "https://api.printools.io/v1/prebuilt-items/{itemId}"
payload = {
"name": "example",
"description": "example",
"status": "draft",
"notes": "example",
"thumbnailUrl": "example",
"tags": ["example"]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'example',
description: 'example',
status: 'draft',
notes: 'example',
thumbnailUrl: 'example',
tags: ['example']
})
};
fetch('https://api.printools.io/v1/prebuilt-items/{itemId}', 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/prebuilt-items/{itemId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'example',
'description' => 'example',
'status' => 'draft',
'notes' => 'example',
'thumbnailUrl' => 'example',
'tags' => [
'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/prebuilt-items/{itemId}"
payload := strings.NewReader("{\n \"name\": \"example\",\n \"description\": \"example\",\n \"status\": \"draft\",\n \"notes\": \"example\",\n \"thumbnailUrl\": \"example\",\n \"tags\": [\n \"example\"\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.printools.io/v1/prebuilt-items/{itemId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"example\",\n \"description\": \"example\",\n \"status\": \"draft\",\n \"notes\": \"example\",\n \"thumbnailUrl\": \"example\",\n \"tags\": [\n \"example\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.printools.io/v1/prebuilt-items/{itemId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"example\",\n \"description\": \"example\",\n \"status\": \"draft\",\n \"notes\": \"example\",\n \"thumbnailUrl\": \"example\",\n \"tags\": [\n \"example\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "OK",
"data": {
"id": "<string>",
"name": "<string>",
"status": "draft",
"tags": [
"<string>"
],
"computedUnitPriceExGst": 123,
"computedTotalQuantity": 123,
"totalQuantity": 123,
"lines": [
{
"id": "<string>",
"preBuiltItemId": "<string>",
"lineType": "garment",
"quantity": 123,
"unitPriceExGst": 123,
"sortOrder": 123,
"garmentCatalogueItemId": "<string>",
"productName": "<string>",
"productSku": "<string>",
"title": "<string>",
"description": "<string>",
"valueType": "Flat",
"percentage": 123,
"customImageUrl": "<string>"
}
],
"variants": [
{
"id": "<string>",
"preBuiltItemLineId": "<string>",
"quantity": 123,
"markupType": "percentage",
"markupValue": 123,
"markupSource": "group",
"unitPriceExGst": 123,
"sortOrder": 123,
"isCustomLine": true,
"showOnDocuments": true,
"size": "<string>",
"colour": "<string>",
"buyPrice": 123,
"extraCost": 123
}
],
"decorations": [
{
"id": "<string>",
"preBuiltItemId": "<string>",
"quantity": 123,
"includeSetupCost": true,
"markupType": "percentage",
"markupValue": 123,
"markupSource": "group",
"colours": [
{
"name": "<string>",
"isBase": true
}
],
"rollUp": true,
"rollUpSetup": true,
"showOnDocuments": true,
"sortOrder": 123,
"decorationItemId": "<string>",
"method": "<string>",
"name": "<string>",
"description": "<string>",
"position": "<string>",
"unitCost": 123,
"setupCost": 123,
"baseUnitCost": 123,
"baseSetupCost": 123,
"notes": "<string>",
"widthCm": 123,
"lengthCm": 123,
"necklineDropCm": 123,
"screenCount": 123,
"screenMeshGrade": "<string>",
"colourCount": 123,
"specialInstructions": "<string>",
"artworkFileUrl": "<string>",
"separationFileUrl": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"notes": "<string>",
"thumbnailUrl": "<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:
prebuiltitems.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
Was this page helpful?

