get
https://{subdomain}.myshoplaza.com/openapi/2025-06/metafield_definition/
Retrieve a list of all metafield definitions.
The Get Metafields List API allows developers to retrieve a list of all metafield definitions for a specific owner resource.
This API is particularly useful for:
- Fetching metadata schema definitions for products, orders, or customers.
- Managing custom field configurations in bulk.
Request Parameters
Public Request Parameters
Path Parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| string | Yes | Type of resource the metafield definition belongs to. Valid values: |
|
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "success" | Status code of the response |
message | string | Descriptive message of the response | |
data.definitions | array[object] | [{...}] | Array of metafield definition objects |
data.definitions.id | string | "mfd_12345" | Unique identifier of the metafield definition |
data.definitions.key | string | "custom_size" | Key identifier for the metafield |
data.definitions.name | string | "Product Size" | Human-readable name of the metafield |
data.definitions.namespace | string | "custom" | Namespace for grouping metafields |
data.definitions.owner_resource | string | "products" | Resource type this definition applies to |
data.definitions.type | string | "string" | Data type of the metafield (e.g., string, integer) |
data.definitions.description | string | "Stores product dimensions" | Detailed explanation of the metafield |
data.definitions.created_at | string | "2025-01-01T00:00:00Z" | Timestamp of creation (ISO 8601) |
data.definitions.updated_at | string | "2025-01-02T12:00:00Z" | Timestamp of last update (ISO 8601) |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |