Extending Models Using Metadata
Saleor gives you the possibility to customize your shop without modifying the core. You can extend most of the common models using the metadata API.
Metadata allows you to store additional information about each object, for example external identifiers for items synchronized with a third party platform. You can also use metadata to customize the way your storefront looks and behaves.
Supported object types
The following models contain metadata fields which data can be modified:
Attribute
Category
Checkout
Collection
Product
ProductVariant
ProductType
App
User
Private and public metadata
All objects support two sets of metadata:
metadata
is public and visible to unauthenticated users.privateMetadata
is protected and visible only to staff users, plugins, and Apps with appropriate permissions.
Modifying both requires the permission to manage the item that metadata is attached to.
Querying metadata
All of the objects types listed above implement the same interface:
Each metadata item is a key-value pair:
Here's an example query that fetches the metadata of the first product:
Updating metadata
The following GraphQL mutations allow you to update and remove metadata:
All resulting types have the same shape:
Examples
Here's an example of how a product's metadata could be updated:
And the same field being removed: