gift_card_item_category

Collection: gift_card_item_categories

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 gift_card_item_categories link relationship of a gift_card using the item_category uri from its self link relationship.

Required Scopes

Full store_full_access
Read gift_cards_read
Write gift_cards_write

Actions

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

Properties (4)

gift_card_uri String

The full API URI of the gift card associated with this gift card item category.

Obtained from the self link relation of a gift card.

item_category_uri String

The full API URI of the item category associated with this gift card item category.

Obtained from the self link relation of an item_category.

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 Gift Card Item Category Relationship
fx:store GET PATCH PUT DELETE This Store
fx:gift_card GET PATCH PUT DELETE This Gift Card
fx:item_category GET PATCH PUT DELETE This Item Category
https://api.foxycart.com/gift_card_item_categories/{id}

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/gift_card_item_categories/123",
      "title": "Gift Card Item Category Relationship"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:gift_card": {
      "href": "https://api.foxycart.com/gift_cards/999",
      "title": "This Gift Card"
    },
    "fx:item_category": {
      "href": "https://api.foxycart.com/item_categories/999",
      "title": "This Item Category"
    }
  },
  "gift_card_uri": "https://api.foxycart.com/gift_cards/2",
  "item_category_uri": "https://api.foxycart.com/item_categories/1078",
  "date_created": "2021-10-27T09:56:55-0700",
  "date_modified": "2021-10-27T09:56:55-0700"
}