Skip to content

Count metafield definitions per owner type

GET
/stores/{storeRef}/metafield-definitions/counts
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/metafield-definitions/counts \
--header 'x-api-key: <x-api-key>'

Returns the number of metafield definitions for each of the nine owner types, with zero for types that have none. Each owner type can hold at most 100 definitions.

Required scopes: read:metafields

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
product
required
number
variant
required
number
collection
required
number
customer
required
number
order
required
number
page
required
number
blog_post
required
number
location
required
number
shop
required
number

Example generated

{
"product": 1,
"variant": 1,
"collection": 1,
"customer": 1,
"order": 1,
"page": 1,
"blog_post": 1,
"location": 1,
"shop": 1
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}