get
https://{shopdomain}.myshoplaza.com/openapi/2022-01/metafield_definition//count
Retrieve the count of specific metafield definitions for a given resource.
This API is especially useful for:
- Calculating the total count of metafield definitions for a resource.
- Verifying metafield definitions exist for provided IDs.
- Managing metafield limits for resources efficiently.
Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all queries are applied to the correct store.
Request Parameters
Public Request Parameters
Path Parameters
| Field | Type | Required | Example | Description |
|---|---|---|---|---|
owner_resource | string | Yes | product | The type of resource that the metafield is attached to. Available resources: shop, product, product_image, product_variant, order, page, customer, collection, blog, article. |
Query Parameters
| Field | Type | Required | Example | Description |
|---|---|---|---|---|
definition_ids | array of string | Yes | ["374034306256875562", "374032579801653802"] | Array of metafield definition IDs to count. |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Example | Description |
|---|---|---|---|
items | array of object | List of metafield count results. | |
items[].metafield_count | integer | 0 | Total count of metafields for the definition. |
items[].definition_id | string | 374034306256875562 | ID of the metafield definition. |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
errors | array | ["invalid own resources"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "store is not active" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
| 422 | "invalid own resources" | empty own resources or invalid resources | "invalid own resources" |