gift_card_codes

Resource: gift_card_code

This link relationship returns a collection of gift card codes. 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 gift_cards_read
Write gift_cards_write

Collection Resource

gift_card_code

Actions

GET View a list of gift_card_codes
POST Create a new gift card code
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

_embedded Object · Read-only

Contains fx:gift_card_codes[] — array of gift_card_code 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}/gift_card_codes
Available via gift_card_codes on customer·fx:gift_card_codes on customer·fx:gift_card_codes on gift_card

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/gift_card_codes",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/gift_card_codes?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/gift_card_codes?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/gift_card_codes?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/gift_card_codes?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:gift_card_codes": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/gift_card_codes/456",
            "title": "This Gift Card Code"
          },
          "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:gift_card_code_logs": {
            "href": "https://api.foxycart.com/gift_card_codes/123/logs",
            "title": "Transactions using this Gift Card Code"
          },
          "fx:provisioned_by_transaction_detail_id": {
            "href": "https://api.foxycart.com/items/999",
            "title": "This Transaction"
          }
        },
        "code": "37373-8LX2VW9D-JTSXQ",
        "current_balance": 12,
        "end_date": "2022-11-10T09:04:39-0800",
        "date_created": "2021-11-10T09:04:39-0800",
        "date_modified": "2021-11-10T09:04:39-0800"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}