tax_item_categories
Description
This link relationship returns a collection of resources. You can easily paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last. Scroll down to view a representation of a single resource embedded within this collection.
Sandbox Example
You can interact with this resource and run actions against the sandbox API via our HAL Brower.
Actions
- GET
- View a list of tax_item_categories
- POST
- Create a new template_set
- HEAD
- Get just the header response
- OPTIONS
- Get a response explaining which HTTP methods are supported
Example Representation
{ "_links": { "curies": [ { "name": "fx", "href": "https://api.foxycart.com/rels/{rel}", "templated": true } ], "self": { "href": "...", "title": "This Collection" }, "first": { "href": "...?offset=0", "title": "First Page of this Collection" }, "prev": { "href": "...?offset=0", "title": "Previous Page of this Collection" }, "next": { "href": "...?offset=0", "title": "Next Page of this Collection" }, "last": { "href": "...?offset=0", "title": "Last Page of this Collection" } }, "_embedded": { "fx:tax_item_categories": [...] }, "total_items": "5", "returned_items": 5, "limit": 20, "offset": 0 }
<?xml version="1.0" encoding="UTF-8"?> <resource href="..."> <link rel="self" href="..." title="This Collection"/> <link rel="first" href="...?offset=0" title="First Page of this Collection"/> <link rel="prev" href="...?offset=0" title="Previous Page of this Collection"/> <link rel="next" href="...?offset=0" title="Next Page of this Collection"/> <link rel="last" href="...?offset=0" title="Last Page of this Collection"/> <resource href="..." rel="https://api.foxycart.com/rels/template_set"> ... </resource> <total_items>5</total_items> <returned_items>5</returned_items> <limit>20</limit> <offset>0</offset> </resource>
{ "properties": { "total_items": "5", "returned_items": 5, "limit": 20, "offset": 0 }, "entities": [...], "links": [ { "rel": [ "self" ], "href": "..." }, { "rel": [ "first" ], "href": "...?offset=0" }, { "rel": [ "prev" ], "href": "...?offset=0" }, { "rel": [ "next" ], "href": "...?offset=0" }, { "rel": [ "last" ], "href": "...?offset=0" } ], "actions": [ ] }
Embedded Resource: template_set
Description
Template sets are collections of templates such as the cart, checkout and receipt for a given store. Currently, we only support a single default template in the store front end, but in the future we will support multiple templates available for a single store.
Sandbox Example
You can interact with this resource and run actions against the sandbox API via our HAL Brower.
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
Property | Description | Type | Constraints |
---|---|---|---|
cart_template_uri | The full API URI of the cart template associated with this template set. | URL | 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 | The full API URI of the cart_include template associated with this template set. | URL | 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 | The full API URI of the checkout template associated with this template set. | URL | 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 | The full API URI of the receipt template associated with this template set. | URL | 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 | The full API URI of the email template associated with this template set. | URL | Obtained from the self link relation of a email_template . If not supplied, a new template is generated when creating a template set. |
payment_method_set_uri | The full API URI of the payment method set associated with this template set. | URL | Obtained from the self link relation of a payment_method_set . If not supplied, the application will use the default payment method set. |
code | The template set code used when applying this template set to the cart. | String | Required. 50 characters or less. If DEFAULT then it can not be modified. |
description | The template set description. (currently only supports the default description). | String | Required. 100 characters or less. If the code is DEFAULT then it can not be modified. |
language | The language configured for this template set. | String | Required. languages |
locale_code | The locale code for this store. This will impact how the currency and dates are displayed. | String | Required. locale_codes |
config | This is the template configuration settings for your store. | String | Required |
date_created | The date this resource was created. | Date | Read only |
date_modified | The date this resource was last modified. | Date | Read only |
Example Representation
{ "_links": { "curies": [ { "name": "fx", "href": "https://api.foxycart.com/rels/{rel}", "templated": true } ], "self": { "href": "https://api-sandbox.foxycart.com/template_sets/6", "title": "This Template Set" }, "fx:store": { "href": "https://api-sandbox.foxycart.com/stores/8", "title": "This Store" }, "fx:cart_template": { "href": "https://api-sandbox.foxycart.com/cart_templates/14", "title": "Cart Template for this template set" }, "fx:cart_include_template": { "href": "https://api-sandbox.foxycart.com/cart_include_templates/16", "title": "Cart Include Template for this template set" }, "fx:checkout_template": { "href": "https://api-sandbox.foxycart.com/checkout_templates/18", "title": "Checkout Template for this template set" }, "fx:receipt_template": { "href": "https://api-sandbox.foxycart.com/receipt_templates/20", "title": "Receipt Template for this template set" }, "fx:email_template": { "href": "https://api-sandbox.foxycart.com/email_templates/10", "title": "Email Template for this template set" }, "fx:language_overrides": { "href": "https://api-sandbox.foxycart.com/template_sets/6/language_overrides", "title": "Language Overrides for this template set" } }, "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": "", "date_created": "2012-08-10T11:58:54-0700", "date_modified": "2012-08-10T11:58:54-0700" }
<?xml version="1.0" encoding="UTF-8"?> <resource href="https://api-sandbox.foxycart.com/template_sets/6" rel="https://api.foxycart.com/rels/template_set"> <link rel="self" href="https://api-sandbox.foxycart.com/template_sets/6" title="This Template Set"/> <link rel="https://api.foxycart.com/rels/store" href="https://api-sandbox.foxycart.com/stores/8" title="This Store"/> <link rel="https://api.foxycart.com/rels/cart_template" href="https://api-sandbox.foxycart.com/cart_templates/14" title="Cart Template for this template set"/> <link rel="https://api.foxycart.com/rels/cart_include_template" href="https://api-sandbox.foxycart.com/cart_include_templates/16" title="Cart Include Template for this template set"/> <link rel="https://api.foxycart.com/rels/checkout_template" href="https://api-sandbox.foxycart.com/checkout_templates/18" title="Checkout Template for this template set"/> <link rel="https://api.foxycart.com/rels/receipt_template" href="https://api-sandbox.foxycart.com/receipt_templates/20" title="Receipt Template for this template set"/> <link rel="https://api.foxycart.com/rels/email_template" href="https://api-sandbox.foxycart.com/email_templates/10" title="Email Template for this template set"/> <link rel="https://api.foxycart.com/rels/language_overrides" href="https://api-sandbox.foxycart.com/template_sets/6/language_overrides" title="Language Overrides for this template set"/> <cart_template_uri>https://api-sandbox.foxycart.com/cart_templates/14</cart_template_uri> <cart_include_template_uri>https://api-sandbox.foxycart.com/cart_include_templates/16</cart_include_template_uri> <checkout_template_uri>https://api-sandbox.foxycart.com/checkout_templates/18</checkout_template_uri> <receipt_template_uri>https://api-sandbox.foxycart.com/receipt_templates/20</receipt_template_uri> <email_template_uri>https://api-sandbox.foxycart.com/email_templates/10</email_template_uri> <code>DEFAULT</code> <description>Default Template Set</description> <language>english.inc.php</language> <locale_code>en_US</locale_code> <config></config> <date_created>2012-08-10T11:58:54-0700</date_created> <date_modified>2012-08-10T11:58:54-0700</date_modified> </resource>
{ "class": [ "template_set" ], "properties": { "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": "", "date_created": "2012-08-10T11:58:54-0700", "date_modified": "2012-08-10T11:58:54-0700" }, "links": [ { "rel": [ "self" ], "href": "https://api-sandbox.foxycart.com/template_sets/6" }, { "rel": [ "https://api.foxycart.com/rels/store" ], "href": "https://api-sandbox.foxycart.com/stores/8" }, { "rel": [ "https://api.foxycart.com/rels/cart_template" ], "href": "https://api-sandbox.foxycart.com/cart_templates/14" }, { "rel": [ "https://api.foxycart.com/rels/cart_include_template" ], "href": "https://api-sandbox.foxycart.com/cart_include_templates/16" }, { "rel": [ "https://api.foxycart.com/rels/checkout_template" ], "href": "https://api-sandbox.foxycart.com/checkout_templates/18" }, { "rel": [ "https://api.foxycart.com/rels/receipt_template" ], "href": "https://api-sandbox.foxycart.com/receipt_templates/20" }, { "rel": [ "https://api.foxycart.com/rels/email_template" ], "href": "https://api-sandbox.foxycart.com/email_templates/10" }, { "rel": [ "https://api.foxycart.com/rels/language_overrides" ], "href": "https://api-sandbox.foxycart.com/template_sets/6/language_overrides" } ] }
Zoomable Resources
The following related resources can be embedded within this resource by including a ?zoom=<child_resource>
parameter. You can also filter by child resources by ?child_resource:property=<property_value>
cart_template
cart_include_template
checkout_template
receipt_template
email_template