template_set

Collection: template_sets

Template sets are collections of templates such as the cart, checkout and receipt for a given store. Currently, only a single default template set is supported in the store front end, but in the future multiple templates will be available for a single store.

Required Scopes

Full store_full_access
Read templates_read
Write templates_write

Actions

GET View a template set
PATCH Update a template set (send only the properties you want to modify)
PUT Replace a template set (send the entire representation)
DELETE Delete a template set
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (15)

cart_template_uri String

The full API URI of the cart template associated with this template set. Obtained from the self link relation of a cart_template. If not supplied, a new template is generated when creating a template set.

cart_include_template_uri String

The full API URI of the cart_include template associated with this template set. Obtained from the self link relation of a cart_include_template. If not supplied, a new template is generated when creating a template set.

checkout_template_uri String

The full API URI of the checkout template associated with this template set. Obtained from the self link relation of a checkout_template. If not supplied, a new template is generated when creating a template set.

receipt_template_uri String

The full API URI of the receipt template associated with this template set. Obtained from the self link relation of a receipt_template. If not supplied, a new template is generated when creating a template set.

email_template_uri String

The full API URI of the email template associated with this template set. Obtained from the self link relation of an email_template. If not supplied, a new template is generated when creating a template set.

payment_method_set_uri String

The full API URI of the payment method set associated with this template set. Obtained from the self link relation of a payment_method_set. If not supplied, the application will use the default payment method set.

template_config_uri String

The full API URI of the template config associated with this template set.

code String

The template set code used when applying this template set to the cart. Required. 50 characters or less. If DEFAULT then it cannot be modified.

description String

The template set description. Required. 100 characters or less. If the code is DEFAULT then it cannot be modified.

language String

The language configured for this template set.

locale_code String

The locale code for this store. This will impact how the currency and dates are displayed.

config String

The template configuration settings for your store.

tax_inclusivity String

Configuration of tax type for your store. By default exclusive.

inclusiveexclusive
date_created String (nullable) · Read-only

The date this resource was created.

date_modified String (nullable) · Read-only

The date this resource was last modified.

Link Relations (11)

self This Template Set
fx:store GET PATCH PUT DELETE This Store
fx:cart_template GET PATCH PUT DELETE Cart Template for this template set
fx:cart_include_template GET PATCH PUT DELETE Cart Include Template for this template set
fx:checkout_template GET PATCH PUT DELETE Checkout Template for this template set
fx:receipt_template GET PATCH PUT DELETE Receipt Template for this template set
fx:email_template GET PATCH PUT DELETE Email Template for this template set
fx:template_config GET PATCH PUT DELETE Template Config for this template set
fx:language_overrides GET POST Language Overrides for this template set
fx:encode POST here to encode a body of html for use with our HMAC cart encryption
fx:payment_method_set GET PATCH PUT DELETE Payment Method Set for this template set.

Only present when the template set has an associated payment method set.

Zoomable Resources

Embed related resources using ?zoom=<resource>. Filter with ?resource:property=value.

cart_template cart_include_template checkout_template receipt_template email_template
https://api.foxycart.com/template_sets/{id}
Available via fx:template_set on cart·fx:template_set on language_override

Example Representation

Zoom
{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/template_sets/123",
      "title": "This Template Set"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:cart_template": {
      "href": "https://api.foxycart.com/cart_templates/999",
      "title": "Cart Template for this template set"
    },
    "fx:cart_include_template": {
      "href": "https://api.foxycart.com/cart_include_templates/999",
      "title": "Cart Include Template for this template set"
    },
    "fx:checkout_template": {
      "href": "https://api.foxycart.com/checkout_templates/999",
      "title": "Checkout Template for this template set"
    },
    "fx:receipt_template": {
      "href": "https://api.foxycart.com/receipt_templates/999",
      "title": "Receipt Template for this template set"
    },
    "fx:email_template": {
      "href": "https://api.foxycart.com/email_templates/999",
      "title": "Email Template for this template set"
    },
    "fx:template_config": {
      "href": "https://api.foxycart.com/template_configs/999",
      "title": "Template Config for this template set"
    },
    "fx:language_overrides": {
      "href": "https://api.foxycart.com/template_sets/123/language_overrides",
      "title": "Language Overrides for this template set"
    },
    "fx:encode": {
      "href": "https://api.foxycart.com/encode",
      "title": "POST here to encode a body of html for use with our HMAC cart encryption"
    }
  },
  "cart_template_uri": "https://api-sandbox.foxycart.com/cart_templates/14",
  "cart_include_template_uri": "https://api-sandbox.foxycart.com/cart_include_templates/16",
  "checkout_template_uri": "https://api-sandbox.foxycart.com/checkout_templates/18",
  "receipt_template_uri": "https://api-sandbox.foxycart.com/receipt_templates/20",
  "email_template_uri": "https://api-sandbox.foxycart.com/email_templates/10",
  "code": "DEFAULT",
  "description": "Default Template Set",
  "language": "english.inc.php",
  "locale_code": "en_US",
  "config": "",
  "tax_inclusivity": "exclusive",
  "date_created": "2012-08-10T11:58:54-0700",
  "date_modified": "2012-08-10T11:58:54-0700"
}