item_categories

Resource: item_category

This link relationship returns a collection of item categories. 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 item_categories_read
Write item_categories_write

Collection Resource

item_category

Actions

GET View a list of item_categories
POST Create a new item category
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

_embedded Object · Read-only

Contains fx:item_categories[] — array of item_category 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}/item_categories
Available via fx:item_categories 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/item_categories",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/item_categories?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/item_categories?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/item_categories?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/item_categories?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:item_categories": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/item_categories/456",
            "title": "This Item Category"
          },
          "fx:store": {
            "href": "https://api.foxycart.com/stores/456",
            "title": "This Store"
          },
          "fx:email_templates": {
            "href": "https://api.foxycart.com/stores/456/email_templates",
            "title": "Email Templates for this store"
          },
          "fx:tax_item_categories": {
            "href": "https://api.foxycart.com/item_categories/123/tax_item_categories",
            "title": "Tax Item Category relationships"
          }
        },
        "admin_email_template_uri": "",
        "customer_email_template_uri": "",
        "gift_recipient_email_template_uri": "https://api.foxycart.com/email_templates/12",
        "code": "DEFAULT",
        "name": "Default for all products",
        "item_delivery_type": "notshipped",
        "max_downloads_per_customer": 3,
        "max_downloads_time_period": 24,
        "customs_value": 0,
        "default_weight": 1,
        "default_weight_unit": "LBS",
        "default_length_unit": "IN",
        "shipping_flat_rate": 0,
        "shipping_flat_rate_type": "per_order",
        "handling_fee": 0,
        "handling_fee_minimum": 0,
        "handling_fee_type": "none",
        "handling_fee_percentage": 0,
        "discount_name": null,
        "discount_type": null,
        "discount_details": null,
        "send_customer_email": false,
        "send_admin_email": false,
        "admin_email": null,
        "date_created": "2012-10-31T14:12:39-0700",
        "date_modified": "2012-10-31T14:12:39-0700"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}