tax_item_category

Description

This resource represents a relationship between a tax and an item category which that tax is applied to. After creating a tax, you then create tax item category entry to ensure any items purchased within that item category will have the tax you specify applied to the transaction.

To apply a tax to an item category, create a new tax_item_category resource. To remove a tax from an item category, delete the tax_item_category resource.

Sandbox Example

You can interact with this resource and run actions against the sandbox API via our HAL Brower.

Actions

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

Properties

Property Description Type Constraints
item_category_uri A full API URI of the item category resource used in this relationship. When working with hypermedia, it's important to save URIs and not just numeric ids. URI Required. Must be a valid item_category uri.
store_uri A full API URI of the tax resource used in this relationship. When working with hypermedia, it's important to save URIs and not just numeric ids. URI Required. Must be a valid tax uri.
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/tax_item_categories/2",
            "title": "This Tax Item Category"
        },
        "fx:store": {
            "href": "https://api-sandbox.foxycart.com/stores/8",
            "title": "This Store"
        },
        "fx:item_category": {
            "href": "https://api-sandbox.foxycart.com/item_categories/13",
            "title": "This Item Category"
        },
        "fx:tax": {
            "href": "https://api-sandbox.foxycart.com/taxes/1672",
            "title": "This Tax"
        }
    },
    "item_category_uri": "https://api-sandbox.foxycart.com/item_categories/13",
    "tax_uri": "https://api-sandbox.foxycart.com/taxes/1672",
    "date_created": "2015-04-27T13:42:55-0700",
    "date_modified": "2015-04-27T13:42:55-0700"
}
<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api-sandbox.foxycart.com/tax_item_categories/2" rel="https://api.foxycart.com/rels/tax_item_category">
  <link rel="self" href="https://api-sandbox.foxycart.com/tax_item_categories/2" title="This Tax Item Category"/>
  <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/item_category" href="https://api-sandbox.foxycart.com/item_categories/13" title="This Item Category"/>
  <link rel="https://api.foxycart.com/rels/tax" href="https://api-sandbox.foxycart.com/taxes/1672" title="This Tax"/>
  <item_category_uri>https://api-sandbox.foxycart.com/item_categories/13</item_category_uri>
  <tax_uri>https://api-sandbox.foxycart.com/taxes/1672</tax_uri>
  <date_created>2015-04-27T13:42:55-0700</date_created>
  <date_modified>2015-04-27T13:42:55-0700</date_modified>
</resource>
{
    "class": [
        "tax_item_category"
    ],
    "properties": {
        "item_category_uri": "https://api-sandbox.foxycart.com/item_categories/13",
        "tax_uri": "https://api-sandbox.foxycart.com/taxes/1672",
        "date_created": "2015-04-27T13:42:55-0700",
        "date_modified": "2015-04-27T13:42:55-0700"
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api-sandbox.foxycart.com/tax_item_categories/2"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store"
            ],
            "href": "https://api-sandbox.foxycart.com/stores/8"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/item_category"
            ],
            "href": "https://api-sandbox.foxycart.com/item_categories/13"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/tax"
            ],
            "href": "https://api-sandbox.foxycart.com/taxes/1672"
        }
    ]
}

Zoomable Resources

This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.