items

Resource: item

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

Actions

GET View a list of items
POST Create a new item
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

_embedded Object · Read-only

Contains fx:items[] — array of item 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/transactions/{transaction_id}/items
Available via fx:items on cart·fx:items on shipment·fx:items on transaction

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/items",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/items?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/items?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/items?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/items?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:items": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/items/456",
            "title": "This Item"
          },
          "fx:store": {
            "href": "https://api.foxycart.com/stores/456",
            "title": "This Store"
          },
          "fx:item_category": {
            "href": "https://api.foxycart.com/item_categories/999",
            "title": "This Item Category"
          },
          "fx:subscription": {
            "href": "https://api.foxycart.com/subscriptions/321",
            "title": "This Subscription"
          },
          "fx:sub_token_url": {
            "href": "https://mystore.foxycart.com/cart?sub_token=e38b9886405ff668f6d11c129e7fde1f8281f3e00dd34c819e0c9370ccb2bd56",
            "title": "This Sub Token"
          },
          "fx:item_options": {
            "href": "https://api.foxycart.com/items/123/item_options",
            "title": "Item Options for This Item"
          },
          "fx:shipment": {
            "href": "https://api.foxycart.com/shipments/456",
            "title": "Shipment for this Item"
          },
          "fx:downloadable_purchase": {
            "href": "https://api.foxycart.com/downloadable_purchases/456",
            "title": "This Downloadable Purchase"
          },
          "fx:provisioned_gift_card_code": {
            "href": "https://api.foxycart.com/provisioned_gift_card_code",
            "title": "The Gift Card Code for this Item"
          },
          "fx:attributes": {
            "href": "https://api.foxycart.com/items/123/attributes",
            "title": "Attributes for This Item"
          },
          "fx:discount_details": {
            "href": "https://api.foxycart.com/items/123/discount_details",
            "title": "The Discounts for this Item"
          },
          "fx:coupon_details": {
            "href": "https://api.foxycart.com/items/123/coupon_details",
            "title": "The Coupons for this Item"
          },
          "fx:item_taxes": {
            "href": "https://api.foxycart.com/item_taxes",
            "title": "The applied taxes for this Item"
          }
        },
        "item_category_uri": "https://api-sandbox.foxycart.com/item_categories/60",
        "name": "basic",
        "price": 10,
        "quantity": 1,
        "quantity_min": 0,
        "quantity_max": 0,
        "weight": 5,
        "code": "",
        "parent_code": "",
        "discount_name": "",
        "discount_type": "",
        "discount_details": "",
        "subscription_frequency": "",
        "subscription_start_date": null,
        "subscription_next_transaction_date": null,
        "subscription_end_date": null,
        "is_future_line_item": false,
        "shipto": "Me",
        "url": "",
        "image": "",
        "length": 0,
        "width": 0,
        "height": 0,
        "expires": 0,
        "date_created": null,
        "date_modified": "2015-04-15T08:45:49-0700"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}