attributes

Resource: attribute

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

On a store:

Read stores_read
Write stores_write

On a customer:

Read customers_read
Write customers_write

On a completed transaction:

Read transactions_read
Write transactions_write

On a cart:

Read carts_read
Write carts_write

On an item (completed transaction):

Read transactions_read
Write transactions_write

On an item (cart):

Read carts_read
Write carts_write

On a subscription:

Read subscriptions_read
Write subscriptions_write

On a shipment:

Read transactions_read
Write transactions_write

On a coupon:

Read coupons_read
Write coupons_write

On a gift card:

Read gift_cards_read
Write gift_cards_write

On a client (requires client_full_access):

Read clients_read
Write clients_write

On a user (requires user_full_access):

Read users_read
Write users_write

Collection Resource

attribute

Actions

GET View a list of attributes
POST Create a new attribute, or create multiple new attributes
PATCH Create new attributes and update existing attributes
PUT Create new attributes by replacing all existing attributes
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

_embedded Object · Read-only

Contains fx:attributes[] — array of attribute 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}/attributes
Available via fx:attributes on cart·fx:attributes on client·fx:attributes on coupon·fx:attributes on customer·fx:attributes on gift_card·fx:attributes on item·fx:attributes on shipment·fx:attributes on store·fx:attributes on subscription·fx:attributes on transaction·fx:attributes on user

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/attributes",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/attributes?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/attributes?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/attributes?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/attributes?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:attributes": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/attributes/456",
            "title": "This Attribute"
          }
        },
        "name": "Hours",
        "value": "9am to 5pm",
        "visibility": "private",
        "date_created": "2013-08-05T14:15:59-0700",
        "date_modified": "2013-08-05T14:15:59-0700"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}