Template Objects

listed below are the sparklayer objects available to use in templates and content zones the objects available will depend on the themes template, refer to this documentation to see which objects are available for specific templates address properties key type description example(s) name string company string address line1 string address line2 string,null city string region code string,null postal code string,null country code string phone string,null customer properties key type description example(s) id string title string first name string last name string email string company name string,null external id string accounting id string contentzone content zones can be configured as part of the invoicing feature note content zones may be configured to contain liquid variables and should be handled in templates accordingly properties key type description example(s) title string,null content string,null invoicesettings properties key type description example(s) content zones zone 1 contentzone docid\ eirrsj kt1yshixnhkcfc content zones zone 2 contentzone docid\ eirrsj kt1yshixnhkcfc content zones zone 3 contentzone docid\ eirrsj kt1yshixnhkcfc lineitem properties key type description example(s) custom attributes \[] key string custom attributes \[] value string identifiers sku string,null name child string,null name parent string quantity integer line total unknown unit total unknown image url string,null product slug string,null rrp unknown barcode string,null linetotal properties key type description example(s) total net money docid\ eirrsj kt1yshixnhkcfc discount net money docid\ eirrsj kt1yshixnhkcfc tax rate number merchant merchant details properties key type description example(s) address1 string,null the address line 1 associated to the merchants store address address2 string,null the address line 2 associated to the merchants store address base currency string,null the base currency used by the store usd,gbp city string,null the city associated to the merchants store address region string,null the region code associated to the merchants store address country string,null the country code associated to the merchants store address gb email string,null the email associated to the merchant phone string,null the phone number associated to the merchants store postcode string,null the postcode associated to the merchants store address store name string,null the connected platforms store name timezone string,null url string,null locale string,null the default locale of the store en,fr money represents a monetary value properties key type description example(s) amount string currency string gbp,usd package properties key type description example(s) line items array of lineitem docid\ eirrsj kt1yshixnhkcfc shipping address address docid\ eirrsj kt1yshixnhkcfc purchase properties key type description example(s) currency code string billing address address docid\ eirrsj kt1yshixnhkcfc customers sparklayer customer docid\ eirrsj kt1yshixnhkcfc custom fields \[] name string custom fields \[] value string,null customer reference string,null dates created at string dates updated at string dates placed at string,null dates calculated submitted at string,null identifiers visible string packages array of package docid\ eirrsj kt1yshixnhkcfc line items array of lineitem docid\ eirrsj kt1yshixnhkcfc subtotal money docid\ eirrsj kt1yshixnhkcfc tax money docid\ eirrsj kt1yshixnhkcfc shipping cost money docid\ eirrsj kt1yshixnhkcfc calculated total money docid\ eirrsj kt1yshixnhkcfc tax lines array of taxline docid\ eirrsj kt1yshixnhkcfc unittotal properties key type description example(s) total net money docid\ eirrsj kt1yshixnhkcfc total gross money docid\ eirrsj kt1yshixnhkcfc total tax money docid\ eirrsj kt1yshixnhkcfc tax rate number taxline properties key type description example(s) title string rate number amount number string amount currency string purchasehistorymessage properties key type description example(s) body string created at string customer customer docid\ eirrsj kt1yshixnhkcfc assignmentdetails properties key type description example(s) assigned by customer docid\ eirrsj kt1yshixnhkcfc assigned on string note this documentation is in beta and may not be accurate, please contact support if you have any issues or questions