gift_card_item_category : Foxy hAPI

gift_card_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 gift_card_item_categories
POST: Create a new gift_card_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:gift_card_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/gift_card_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: gift_card_item_category

Description

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

Interact with this resource

Actions

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

Properties

Property	Description	Type	Constraints
gift_card_uri	The full API URI of the gift card associated with this gift card item category.	URL	Obtained from the self link relation of a gift card.
item_category_uri	The full API URI of the item category associated with this gift card 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.foxycart.test/gift_card_item_categories/1",
            "title": "Gift Card Item Category Relationship"
        },
        "fx:store": {
            "href": "https://api.foxycart.test/stores/40075",
            "title": "This Store"
        },
        "fx:gift_card": {
            "href": "https://api.foxycart.test/gift_cards/2",
            "title": "This Gift Card"
        },
        "fx:item_category": {
            "href": "https://api.foxycart.test/item_categories/1078",
            "title": "This Item Category"
        }
    },
    "gift_card_uri": "https://api.foxycart.test/gift_cards/2",
    "item_category_uri": "https://api.foxycart.test/item_categories/1078",
    "date_created": "2021-10-27T09:56:55-0700",
    "date_modified": "2021-10-27T09:56:55-0700"
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api.foxycart.test/gift_card_item_categories/1" rel="https://api.foxycart.com/rels/gift_card_item_category">
  <link rel="self" href="https://api.foxycart.test/gift_card_item_categories/1" title="Gift Card Item Category Relationship"/>
  <link rel="https://api.foxycart.com/rels/store" href="https://api.foxycart.test/stores/40075" title="This Store"/>
  <link rel="https://api.foxycart.com/rels/gift_card" href="https://api.foxycart.test/gift_cards/2" title="This Gift Card"/>
  <link rel="https://api.foxycart.com/rels/item_category" href="https://api.foxycart.test/item_categories/1078" title="This Item Category"/>
  <gift_card_uri>https: //api.foxycart.test/gift_cards/2</gift_card_uri>
  <item_category_uri>https: //api.foxycart.test/item_categories/1078</item_category_uri>
  <date_created>2021-10-27T09: 56: 55-0700</date_created>
  <date_modified>2021-10-27T09: 56: 55-0700</date_modified>
</resource>

{
    "class": [
        "gift_card_item_category"
    ],
    "properties": {
        "gift_card_uri": "https://api.foxycart.test/gift_cards/2",
        "item_category_uri": "https://api.foxycart.test/item_categories/1078",
        "date_created": "2021-10-27T09:56:55-0700",
        "date_modified": "2021-10-27T09:56:55-0700"
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api.foxycart.test/gift_card_item_categories/1"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store"
            ],
            "href": "https://api.foxycart.test/stores/40075"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/gift_card"
            ],
            "href": "https://api.foxycart.test/gift_cards/2"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/item_category"
            ],
            "href": "https://api.foxycart.test/item_categories/1078"
        }
    ],
    "actions": [
        {
            "name": "self",
            "title": "Update Gift Card Item Category",
            "method": "PATCH",
            "href": "https://api.foxycart.test/gift_card_item_categories/1",
            "type": "application/x-www-form-urlencoded",
            "fields": [
                {
                    "name": "gift_card_uri",
                    "title": "Gift Card URI",
                    "type": "url",
                    "value": "https://api.foxycart.test/gift_cards/2"
                },
                {
                    "name": "item_category_uri",
                    "title": "Item Category URI",
                    "type": "url",
                    "value": "https://api.foxycart.test/item_categories/1078"
                }
            ]
        }
    ]
}

Zoomable Resources

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