item_option

Collection: item_options

An item option is a property added to the cart for an item which isn't part of the standard item properties such as name, weight, etc. Examples include size, color, or anything else added during the add to cart process.

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

Actions

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

Properties (6)

name String · Required · max 100

The name of this item option.

value String · Required · max 1024

The value of this item option.

price_mod Number · Optional

The price modifier for this item option. The price of the item in the cart will be adjusted by this amount because of this item option.

weight_mod Number · Optional

The weight modifier for this item option. The weight of the item in the cart will be adjusted by this amount because of this item option.

Up to three decimal places.

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 (5)

self This Item Option
fx:store GET PATCH PUT DELETE This Store
fx:item GET PATCH PUT DELETE This Item
fx:transaction GET PATCH PUT POST The transaction this item option belongs to.

Only present when this item option belongs to a completed transaction.

fx:cart GET PATCH PUT POST DELETE The cart this item option belongs to.

Only present when this item option belongs to an incomplete transaction (cart).

https://api.foxycart.com/item_options/{id}

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/item_options/123",
      "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"
}