Tenant credential
curl --request PATCH 'https://api.printools.io/v1/purchase-order-lines/11111111-2222-3333-4444-555555555555' \
--header 'X-API-Key: $PRINTOOLS_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"itemType":"Product","code":"example","name":"example","description":"example","colour":"example"}'import requests
url = "https://api.printools.io/v1/purchase-order-lines/{lineId}"
payload = {
"itemType": "Product",
"code": "example",
"name": "example",
"description": "example",
"colour": "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({
itemType: 'Product',
code: 'example',
name: 'example',
description: 'example',
colour: 'example'
})
};
fetch('https://api.printools.io/v1/purchase-order-lines/{lineId}', 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/purchase-order-lines/{lineId}",
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([
'itemType' => 'Product',
'code' => 'example',
'name' => 'example',
'description' => 'example',
'colour' => '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/purchase-order-lines/{lineId}"
payload := strings.NewReader("{\n \"itemType\": \"Product\",\n \"code\": \"example\",\n \"name\": \"example\",\n \"description\": \"example\",\n \"colour\": \"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/purchase-order-lines/{lineId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"itemType\": \"Product\",\n \"code\": \"example\",\n \"name\": \"example\",\n \"description\": \"example\",\n \"colour\": \"example\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.printools.io/v1/purchase-order-lines/{lineId}")
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 \"itemType\": \"Product\",\n \"code\": \"example\",\n \"name\": \"example\",\n \"description\": \"example\",\n \"colour\": \"example\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "OK",
"data": {
"id": "<string>",
"poNumber": "<string>",
"subtotalExGst": 123,
"taxRatePct": 123,
"gstAmount": 123,
"totalIncGst": 123,
"status": "Draft",
"sentStatus": "NotSent",
"isActive": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"lineItems": [
{
"id": "<string>",
"purchaseOrderId": "<string>",
"itemType": "Product",
"name": "<string>",
"quantity": 123,
"rate": 123,
"ordered": true,
"received": true,
"subtotal": 123,
"sortOrder": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"code": "<string>",
"description": "<string>",
"colour": "<string>",
"size": "<string>",
"quantityOrdered": 123,
"quantityOnBackorder": 123,
"backorderDate": "2023-12-25",
"notes": "<string>"
}
],
"vendors": [
{
"id": "<string>",
"name": "<string>",
"kind": "InventorySupplier",
"serviceTypes": [
"ScreenPrint"
],
"isActive": true,
"isManaged": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"contacts": [
{
"id": "<string>",
"vendorId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"role": "<string>"
}
],
"addresses": [
{
"id": "<string>",
"vendorId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"label": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>"
}
],
"logoUrl": "<string>",
"ordersWebsite": "<string>",
"accountNumber": "<string>",
"defaultLeadTimeDays": 123,
"minimumOrder": 123,
"proximityNotes": "<string>",
"notes": "<string>"
}
],
"title": "<string>",
"referenceNumber": "<string>",
"jobId": "<string>",
"quoteId": "<string>",
"deadline": "2023-12-25"
}
}{
"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
}Purchase orders
Update a purchase-order line
Requires the scope purchaseorders.write.
PATCH
/
v1
/
purchase-order-lines
/
{lineId}
Tenant credential
curl --request PATCH 'https://api.printools.io/v1/purchase-order-lines/11111111-2222-3333-4444-555555555555' \
--header 'X-API-Key: $PRINTOOLS_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"itemType":"Product","code":"example","name":"example","description":"example","colour":"example"}'import requests
url = "https://api.printools.io/v1/purchase-order-lines/{lineId}"
payload = {
"itemType": "Product",
"code": "example",
"name": "example",
"description": "example",
"colour": "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({
itemType: 'Product',
code: 'example',
name: 'example',
description: 'example',
colour: 'example'
})
};
fetch('https://api.printools.io/v1/purchase-order-lines/{lineId}', 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/purchase-order-lines/{lineId}",
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([
'itemType' => 'Product',
'code' => 'example',
'name' => 'example',
'description' => 'example',
'colour' => '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/purchase-order-lines/{lineId}"
payload := strings.NewReader("{\n \"itemType\": \"Product\",\n \"code\": \"example\",\n \"name\": \"example\",\n \"description\": \"example\",\n \"colour\": \"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/purchase-order-lines/{lineId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"itemType\": \"Product\",\n \"code\": \"example\",\n \"name\": \"example\",\n \"description\": \"example\",\n \"colour\": \"example\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.printools.io/v1/purchase-order-lines/{lineId}")
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 \"itemType\": \"Product\",\n \"code\": \"example\",\n \"name\": \"example\",\n \"description\": \"example\",\n \"colour\": \"example\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "OK",
"data": {
"id": "<string>",
"poNumber": "<string>",
"subtotalExGst": 123,
"taxRatePct": 123,
"gstAmount": 123,
"totalIncGst": 123,
"status": "Draft",
"sentStatus": "NotSent",
"isActive": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"lineItems": [
{
"id": "<string>",
"purchaseOrderId": "<string>",
"itemType": "Product",
"name": "<string>",
"quantity": 123,
"rate": 123,
"ordered": true,
"received": true,
"subtotal": 123,
"sortOrder": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"code": "<string>",
"description": "<string>",
"colour": "<string>",
"size": "<string>",
"quantityOrdered": 123,
"quantityOnBackorder": 123,
"backorderDate": "2023-12-25",
"notes": "<string>"
}
],
"vendors": [
{
"id": "<string>",
"name": "<string>",
"kind": "InventorySupplier",
"serviceTypes": [
"ScreenPrint"
],
"isActive": true,
"isManaged": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"contacts": [
{
"id": "<string>",
"vendorId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"role": "<string>"
}
],
"addresses": [
{
"id": "<string>",
"vendorId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"label": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>"
}
],
"logoUrl": "<string>",
"ordersWebsite": "<string>",
"accountNumber": "<string>",
"defaultLeadTimeDays": 123,
"minimumOrder": 123,
"proximityNotes": "<string>",
"notes": "<string>"
}
],
"title": "<string>",
"referenceNumber": "<string>",
"jobId": "<string>",
"quoteId": "<string>",
"deadline": "2023-12-25"
}
}{
"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:
purchaseorders.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:
Product, Decoration, Other Was this page helpful?

