template_sets

Resource: template_set

This link relationship returns a collection of template sets. You can paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last.

Required Scopes

Full store_full_access
Read templates_read
Write templates_write

Collection Resource

template_set

Actions

GET View a list of template_sets
POST Create a new template set
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

_embedded Object · Read-only

Contains fx:template_sets[] — array of template_set resources

total_items String · Read-only

Total number of resources in this collection.

returned_items Number · Read-only

Number of resources returned in this page.

limit Number · Read-only

Maximum number of resources per page.

offset Number · Read-only

Number of resources skipped.

Link Relations (5)

self This Collection
first First Page of this Collection
prev Previous Page of this Collection
next Next Page of this Collection
last Last Page of this Collection
https://api.foxycart.com/stores/{store_id}/template_sets
Available via fx:template_sets on admin_email_template·fx:template_sets on cart_include_template·fx:template_sets on cart_template·fx:template_sets on checkout_template·fx:template_sets on customer_email_template·fx:template_sets on email_template·fx:template_sets on receipt_template·fx:template_sets on store·fx:template_sets on template_config·fx:template_sets on transaction

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/template_sets",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/template_sets?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/template_sets?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/template_sets?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/template_sets?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:template_sets": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/template_sets/456",
            "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"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}