tax_item_category

Collection: tax_item_categories

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 a 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.

Required Scopes

Full store_full_access
Read tax_settings_read
Write tax_settings_write

Actions

GET View a tax item category relationship
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 relationship
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (4)

item_category_uri String · Required

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.

Must be a valid item_category uri.

tax_uri String · Required

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.

Must be a valid tax uri.

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 (4)

self This Tax Item Category
fx:store GET PATCH PUT DELETE This Store
fx:item_category GET PATCH PUT DELETE This Item Category
fx:tax GET PATCH PUT DELETE This Tax
https://api.foxycart.com/tax_item_categories/{id}

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/tax_item_categories/123",
      "title": "This Tax Item Category"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:item_category": {
      "href": "https://api.foxycart.com/item_categories/999",
      "title": "This Item Category"
    },
    "fx:tax": {
      "href": "https://api.foxycart.com/taxes/999",
      "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"
}