Difference between revisions of "API Metafield"
From Spiffy Stores Knowledge Base
(Created page with "The Spiffy Stores API Metafield object allows you to attach metadata to a number of your Store's objects. In this context, metadata represents any sort of data that can be re...") |
m |
||
| Line 1: | Line 1: | ||
The Spiffy Stores API Metafield object allows you to attach metadata to a number of your Store's objects. | The Spiffy Stores API Metafield object allows you to attach metadata to a number of your Store's objects. | ||
| − | In this context, metadata represents any sort of data that can be represented by a ''key | + | In this context, metadata represents any sort of data that can be represented by a ''key/value'' structure and can be associated with one of the following types of store objects. |
* Product | * Product | ||
| Line 11: | Line 11: | ||
* Customer | * Customer | ||
* Order | * Order | ||
| + | |||
| + | A Metafield has the following properties: | ||
| + | |||
| + | * Namespace | ||
| + | * Key | ||
| + | * Value | ||
| + | * Value Type (''integer'' or ''string'') | ||
| + | * Description (Optional) | ||
| + | |||
| + | The Namespace allows you to group a number of related keys together. | ||
| + | |||
| + | Within a Namespace, there will be one or more unique Keys. | ||
| + | |||
| + | Each Key within the Namespace will have a Value which may be either an ''integer'' or ''string'' value. | ||
| + | |||
| + | Finally, for documentation purposes, an optional Description may also be added when the Metafield is created. | ||
Revision as of 13:47, 18 February 2015
The Spiffy Stores API Metafield object allows you to attach metadata to a number of your Store's objects.
In this context, metadata represents any sort of data that can be represented by a key/value structure and can be associated with one of the following types of store objects.
- Product
- Variation
- Page
- Blog
- Standard Collection
- Super Collection
- Customer
- Order
A Metafield has the following properties:
- Namespace
- Key
- Value
- Value Type (integer or string)
- Description (Optional)
The Namespace allows you to group a number of related keys together.
Within a Namespace, there will be one or more unique Keys.
Each Key within the Namespace will have a Value which may be either an integer or string value.
Finally, for documentation purposes, an optional Description may also be added when the Metafield is created.