cart_templates

Resource: cart_template

This link relationship returns a collection of cart templates. 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

cart_template

Actions

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

Properties (5)

_embedded Object · Read-only

Contains fx:cart_templates[] — array of cart_template 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}/cart_templates
Available via cart_templates on default_templates·fx:cart_templates on store

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/cart_templates",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/cart_templates?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/cart_templates?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/cart_templates?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/cart_templates?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:cart_templates": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/cart_templates/456",
            "title": "This Template"
          },
          "fx:store": {
            "href": "https://api.foxycart.com/stores/456",
            "title": "This Store"
          },
          "fx:template_sets": {
            "href": "https://api.foxycart.com/cart_templates/123/template_sets",
            "title": "Template Sets using this template"
          },
          "fx:cache": {
            "href": "https://api.foxycart.com/cart_templates/123/cache",
            "title": "POST here to cache your template using the content_url"
          },
          "fx:encode": {
            "href": "https://api.foxycart.com/encode",
            "title": "POST here to encode a body of html for use with our HMAC cart encryption."
          }
        },
        "description": "Cart Template",
        "content": "",
        "content_url": "",
        "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
}