coupon_item_category : Foxy hAPI

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

Interact with this resource

To interact with this resource and see it in the context of the API, you can utilise Postman or your Terminal/Console to perform requests. If you have a Foxy store, you can also use the API browser in the admin to interact with resources connected to your store.

Actions

GET: View a list of coupon_item_categories
POST: Create a new coupon_item_category
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:coupon_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/coupon_item_category">
  ...
  </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: coupon_item_category

Description

This resource represents a relationship between a coupon and an item_category for the purpose of limiting which categories the coupon applies to. To add an item category limitation to a coupon, you create a coupon item category resource by sending a POST to the coupon_item_categories link relationship of a coupon using the item_category uri from its self link relationship.

Interact with this resource

Actions

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

Properties

Property	Description	Type	Constraints
coupon_uri	The full API URI of the coupon associated with this coupon item category.	URL	Obtained from the self link relation of a coupon.
item_category_uri	The full API URI of the item category associated with this coupon item category.	URL	Obtained from the self link relation of an item_category.
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/coupon_item_categories/278",
            "title": "Coupon Item Category Relationship"
        },
        "fx:store": {
            "href": "https://api-sandbox.foxycart.com/stores/8",
            "title": "This Store"
        },
        "fx:coupon": {
            "href": "https://api-sandbox.foxycart.com/coupons/813",
            "title": "This Coupon"
        },
        "fx:item_category": {
            "href": "https://api-sandbox.foxycart.com/item_categories/307",
            "title": "This Item Category"
        }
    },
    "coupon_uri": "https://api-sandbox.foxycart.com/coupons/813",
    "item_category_uri": "https://api-sandbox.foxycart.com/item_categories/307",
    "date_created": "2015-05-27T12:38:46-0700",
    "date_modified": "2015-05-27T12:38:46-0700"
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api-sandbox.foxycart.com/coupon_item_categories/278" rel="https://api.foxycart.com/rels/coupon_item_category">
  <link rel="self" href="https://api-sandbox.foxycart.com/coupon_item_categories/278" title="Coupon Item Category Relationship"/>
  <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/coupon" href="https://api-sandbox.foxycart.com/coupons/813" title="This Coupon"/>
  <link rel="https://api.foxycart.com/rels/item_category" href="https://api-sandbox.foxycart.com/item_categories/307" title="This Item Category"/>
  <coupon_uri>https://api-sandbox.foxycart.com/coupons/813</coupon_uri>
  <item_category_uri>https://api-sandbox.foxycart.com/item_categories/307</item_category_uri>
  <date_created>2015-05-27T12:38:46-0700</date_created>
  <date_modified>2015-05-27T12:38:46-0700</date_modified>
</resource>

{
    "class": [
        "coupon_item_category"
    ],
    "properties": {
        "coupon_uri": "https://api-sandbox.foxycart.com/coupons/813",
        "item_category_uri": "https://api-sandbox.foxycart.com/item_categories/307",
        "date_created": "2015-05-27T12:38:46-0700",
        "date_modified": "2015-05-27T12:38:46-0700"
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api-sandbox.foxycart.com/coupon_item_categories/278"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store"
            ],
            "href": "https://api-sandbox.foxycart.com/stores/8"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/coupon"
            ],
            "href": "https://api-sandbox.foxycart.com/coupons/813"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/item_category"
            ],
            "href": "https://api-sandbox.foxycart.com/item_categories/307"
        }
    ]
}

Zoomable Resources

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