Update template
/templates/{id}Costs 2 rate-limit points · Rate limits
Change a template: its name, which order kinds it is the default for, logo, style, numbering, any editor section switch or text (sections.<group>.<field>, exactly as the read lists them), label overrides, content translations or the Liquid source. Deep partial. Returns the template in full.
Applies to every document generated from this template from now on; existing PDFs are unchanged. Setting a default_for kind clears it on the other templates. The Pay now link needs a paid plan.
Also searched asedit templateshow the sku on invoiceshide product images on the invoicerename templatechange the accent colourmake this the default invoice templateset the invoice prefix on a templateturn off the footer notes
Path parameters
idstringRequiredTemplate id.
Request body
namestringTemplate name, unique in the store.
default_forobjectShow 4 child attributesHide child attributes
ordersbooleanUse this template for regular orders by default (clears it on the other templates).
draft_ordersbooleanDefault for draft orders / quotes.
pos_ordersbooleanDefault for POS orders.
credit_notesbooleanDefault for credit notes.
logoobjectShow 4 child attributesHide child attributes
enabledbooleanurlstring, nullableLogo image URL; replaces an uploaded logo.
widthinteger, nullableLogo width in pixels.
lock_aspect_ratioboolean
styleobjectShow 4 child attributesHide child attributes
accent_colorstring, nullableHex colour, e.g. #1a1a1a.
font_familystring, nullablefont_sizeinteger, nullabledate_formatstring, nullablee.g. MMM DD, YYYY or DD/MM/YYYY.
numberingobjectShow 4 child attributesHide child attributes
prefixstring, nullableInvoice number prefix for this template.
next_numberstring, nullableNext sequential number (digits). Applied as sent; read the template first.
use_order_numberbooleanNumber invoices after the Shopify order number.
credit_notes_use_order_numberboolean
sectionsobjectShow 8 child attributesHide child attributes
order_informationobjectShow 14 child attributesHide child attributes
show_invoice_numberbooleanshow_custom_invoice_numberbooleanshow_order_numberbooleanshow_po_numberbooleanshow_delivery_note_numberbooleanshow_order_datebooleanshow_issue_datebooleanshow_due_datebooleanshow_fulfillment_datebooleanshow_payment_termsbooleanshow_order_amountbooleanshow_order_tagsbooleanshow_barcodebooleanshow_order_barcodeboolean
payment_informationobjectShow 10 child attributesHide child attributes
show_payment_addressbooleanshow_payment_methodbooleanshow_payment_breakdownbooleanshow_credit_cardbooleanshow_financial_statusbooleanshow_discount_codebooleanshow_tax_datebooleanshow_tracking_companybooleanshow_tracking_numbersbooleanshow_paid_by_customerboolean
shipping_informationobjectShow 1 child attributeHide child attributes
show_shipping_addressboolean
customer_informationobjectShow 5 child attributesHide child attributes
show_customer_emailbooleanshow_customer_phonebooleanshow_customer_notebooleanshow_localized_tax_idbooleanlocalized_tax_id_stringstring, nullable
itemsobjectShow 21 child attributesHide child attributes
show_product_imagesbooleanshow_skubooleanExample:falseshow_hs_codebooleanshow_product_weightbooleanshow_total_product_weightbooleanshow_country_of_originbooleanshow_product_typebooleanshow_product_descriptionbooleanshow_note_attributesbooleanshow_variantsbooleanshow_selling_planbooleanshow_item_discountbooleanshow_discount_reasonbooleanshow_compare_at_pricebooleanshow_original_pricebooleanshow_propertiesbooleanshow_item_barcodebooleanshow_total_qtybooleanshow_item_taxbooleanshow_item_tax_amountbooleangroup_amount_digitsboolean
order_totalobjectShow 16 child attributesHide child attributes
show_subtotalbooleanshow_order_discountbooleanshow_order_discount_reasonbooleanshow_discount_breakdownbooleanshow_taxbooleanshow_tax_inclusion_labelbooleanshow_tax_breakdownbooleanshow_shippingbooleanshow_discountsbooleanshow_shipping_rate_namebooleanshow_amount_in_wordsbooleanshow_total_weightbooleanshow_refund_amountbooleanshow_refund_reasonbooleanshow_payment_linkbooleanshow_balanceboolean
extraobjectShow 6 child attributesHide child attributes
show_order_notesbooleanshow_footer_notesbooleanfooter_messagestring, nullableshow_store_domainbooleanstore_domain_textstring, nullableshow_paid_unpaid_watermarkboolean
socialobjectShow 4 child attributesHide child attributes
show_social_pagebooleanfacebook_urlstring, nullableinstagram_urlstring, nullabletwitter_urlstring, nullable
label_overridesobjectLabel text per field, e.g. { "invoice_number": "Rechnungsnummer" }.
content_translationsobjectText per field per language, e.g. { "footer_message": { "de": "Danke" } }. The only field is footer_message; languages are the store locale codes (de, fr, es...). Sent whole: it replaces the stored value, and blank entries are dropped, so {} clears every translation.
liquid_codestringThe Liquid source of the template body.
Returns
The template object.
Errors
Missing or unknown X-Auth-Token, or the shop uninstalled the app.
v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.
The resource does not exist for this shop, or no action is registered at this path.
The request failed validation. Nothing was saved.
Rate limited: cost-weighted per key (reads cost less than writes). Wait Retry-After seconds; see X-RateLimit-* headers.
Every error has the same shape: see Errors.
curl -X PATCH "https://app.invoicefalcon.com/api/v3/external/templates/125" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Renamed",
"sections": {
"items": {
"show_sku": false
}
},
"numbering": {
"prefix": "R-",
"next_number": "501"
},
"style": {
"accent_color": "#ff0000"
}
}'const res = await fetch("https://app.invoicefalcon.com/api/v3/external/templates/125", {
method: "PATCH",
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "Renamed",
"sections": {
"items": {
"show_sku": false
}
},
"numbering": {
"prefix": "R-",
"next_number": "501"
},
"style": {
"accent_color": "#ff0000"
}
}),
});
const data = await res.json();import os
import requests
res = requests.patch(
"https://app.invoicefalcon.com/api/v3/external/templates/125",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
json={
"name": "Renamed",
"sections": {
"items": {
"show_sku": False
}
},
"numbering": {
"prefix": "R-",
"next_number": "501"
},
"style": {
"accent_color": "#ff0000"
}
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/templates/125")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"], "Content-Type" => "application/json")
req.body = {
name: "Renamed",
sections: {
items: {
show_sku: false
}
},
numbering: {
prefix: "R-",
next_number: "501"
},
style: {
accent_color: "#ff0000"
}
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"id": 175,
"name": "Renamed",
"document_type": "invoice",
"design": {
"key": "modern",
"name": "Modern"
},
"default_for": {
"orders": true,
"draft_orders": false,
"pos_orders": false,
"credit_notes": false
},
"logo": {
"enabled": true,
"url": null,
"width": 150,
"lock_aspect_ratio": true
},
"created_at": "2026-11-10T09:07:44Z",
"updated_at": "2026-11-10T09:07:44Z",
"style": {
"accent_color": "#ff0000",
"font_family": "Arial",
"font_size": 12,
"date_format": "MMM DD, YYYY"
},
"numbering": {
"prefix": "R-",
"next_number": "501",
"use_order_number": true,
"credit_notes_use_order_number": false,
"sequential_numbering_available": true
},
"sections": {
"order_information": {
"show_invoice_number": true,
"show_custom_invoice_number": false,
"show_order_number": true,
"show_po_number": false,
"show_delivery_note_number": false,
"show_order_date": true,
"show_issue_date": false,
"show_due_date": false,
"show_fulfillment_date": false,
"show_payment_terms": false,
"show_order_amount": true,
"show_order_tags": false,
"show_barcode": false,
"show_order_barcode": false
},
"payment_information": {
"show_payment_address": true,
"show_payment_method": true,
"show_payment_breakdown": false,
"show_credit_card": true,
"show_financial_status": false,
"show_discount_code": false,
"show_tax_date": false,
"show_tracking_company": false,
"show_tracking_numbers": false,
"show_paid_by_customer": true
},
"shipping_information": {
"show_shipping_address": true
},
"customer_information": {
"show_customer_email": true,
"show_customer_phone": true,
"show_customer_note": true,
"show_localized_tax_id": false,
"localized_tax_id_string": "Tax ID"
},
"items": {
"show_product_images": true,
"show_sku": false,
"show_hs_code": false,
"show_product_weight": false,
"show_total_product_weight": false,
"show_country_of_origin": false,
"show_product_type": false,
"show_product_description": false,
"show_note_attributes": false,
"show_variants": true,
"show_selling_plan": false,
"show_item_discount": false,
"show_discount_reason": false,
"show_compare_at_price": false,
"show_original_price": false,
"show_properties": true,
"show_item_barcode": false,
"show_total_qty": false,
"show_item_tax": true,
"show_item_tax_amount": true,
"group_amount_digits": false
},
"order_total": {
"show_subtotal": true,
"show_order_discount": true,
"show_order_discount_reason": false,
"show_discount_breakdown": false,
"show_tax": true,
"show_tax_inclusion_label": false,
"show_tax_breakdown": true,
"show_shipping": true,
"show_discounts": true,
"show_shipping_rate_name": true,
"show_amount_in_words": false,
"show_total_weight": false,
"show_refund_amount": true,
"show_refund_reason": false,
"show_payment_link": false,
"show_balance": true
},
"extra": {
"show_order_notes": true,
"show_footer_notes": false,
"footer_message": null,
"show_store_domain": false,
"store_domain_text": null,
"show_paid_unpaid_watermark": false
},
"social": {
"show_social_page": false,
"facebook_url": null,
"instagram_url": null,
"twitter_url": null
}
},
"label_overrides": {},
"content_translations": {},
"liquid_code": " <!DOCTYPE html>\n <html>\n <head>\n <meta charset=\"utf-8\">\n <link href=\"https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=Open+Sans:wght@400;600;700&family=No…"
}{
"errors": [
"Invalid API key"
],
"code": "unauthorized"
}{
"errors": [
"API access requires a paid plan"
],
"code": "paid_plan_required"
}{
"errors": [
"Resource not found"
],
"code": "not_found"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}