item_options

Resource: item_option

This link relationship returns a collection of item options. 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

When part of a completed transaction:

Read transactions_read
Write transactions_write

When part of a cart:

Read carts_read
Write carts_write

Collection Resource

item_option

Actions

GET View a list of item_options
POST Create a new item option
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_options[] — array of item_option 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/items/{item_id}/item_options
Available via fx:item_options on item

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/item_options",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/item_options?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/item_options?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/item_options?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/item_options?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:item_options": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/item_options/456",
            "title": "This Item Option"
          },
          "fx:store": {
            "href": "https://api.foxycart.com/stores/456",
            "title": "This Store"
          },
          "fx:item": {
            "href": "https://api.foxycart.com/items/999",
            "title": "This Item"
          }
        },
        "name": "color",
        "value": "blue",
        "price_mod": 0,
        "weight_mod": 0,
        "date_created": "2012-02-29T13:55:09-0800",
        "date_modified": "2012-02-29T13:55:09-0800"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}