Metafield
Read and write custom metadata (metafields) attached to store resources.
Metafields let merchants and apps attach custom, structured data to shop-level records and to resources such as products, orders, customers, collections, and pages, extending the default data model with namespaced key/value pairs.
Provides endpoints to list, get, create, update, delete, and count shop metafields, and to manage metafields attached to other owner resources.
List shop metafields
The List Shop Metafield List API allows developers to fetch comprehensive information about a shop's metafields by using its unique identifier and configurable query parameters. This endpoint supports retrieving specific fields based on the user’s request.
Create shop metafield
The Create Shop Metafield API allows developers to create a new metafield for a shop. This endpoint requires the meta field data in the request body.
Get shop metafield
The Get Shop Metafield API allows developers to fetch comprehensive information about a shop's metafield by using its unique identifier and configurable query parameters. This endpoint supports retrieving specific fields based on the user’s request.
Delete shop metafield
The Delete Shop Metafield API allows developers to delete an existing metafield for a shop. This endpoint requires the meta field ID in the request URL.
Update shop meta field
The Update Shop Metafield API allows developers to update an existing metafield for a shop. This endpoint requires the meta field ID and the updated data in the request body.
Get shop metafield count
The Shop Metafield Count API allows developers to fetch the total number of metafields for a shop. This endpoint supports retrieving specific fields based on the user’s request.
List metafields
Retrieve a list of metafields for a specific resource.
Create metafield
Create a new metafield for the specified resource.
Get metafield
Retrieve a metafield by its ID.
Delete metafield
Delete a metafield by its ID.
Update metafield
Update an existing metafield of the specified resource.
Get metafield count
Retrieve the count of metafields for a specific resource.