Get metafield definitions 

GET https://{handle}.myshopline.com/admin/openapi/v20260301/metafield_definitions.json
handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .
Get a list of metafield definitions. Specify query parameters to limit and filter the results.
Query Parameters
  • created_at_min string
    Specify the initial creation date and time for metafield definitions to query. Metafield definitions created on and after this time are returned. Format: ISO 8601.
    Example: 2021-04-25T16:16:47+04:00
  • key string
    A unique identifier for a metafield definition within its namespace.
    Only letters, numbers, hyphens, and underscores are supported.
    Minimum length: 3
    Maximum length: 30
    Example: my_key-01
  • limit string
    The maximum number of metafield definitions to return.
    Value range: 1-250
    Default value: 50
  • owner_resource string required
    The type of the resource to which the metafield definition belongs. Valid values are:
    • products: products
    • variants: product variants
    • collections: product collections
    • customers: customers
    • orders: orders
    • pages: pages
    • blogs: blogs collections
    • articles: blogs
    • shop: store
    Example: products
  • updated_at_min string
    Specify the initial update date for metafield definitions to query. Metafield definitions updated on and after this time are returned. Format: ISO 8601.
    Example: 2021-04-25T16:16:47+04:00
  • access_admin string
    The access permission for the metafield definition. Valid values are:
    • MERCHANT_READ_WRITE: Merchants can read and write.
    • MERCHANT_READ: Merchants have read-only access.
    • PUBLIC_READ: The public has read-only access.
    • PRIVATE: Accessible only to the current app.
    • NONE: No explicit permission set.
  • definition_state string
    The state of the metafield definition. Valid values are:
    • CREATED: Metafield definitions that have been created and are currently valid.
    • ALL: Metafield definitions in any state.
    Default value: CREATED
  • namespace string
    The namespace of the metafield definition. A metafield definition can be uniquely identified by its key and namespace. Only letters, numbers, hyphens, and underscores are supported.
    Minimum length: 2
    Maximum length: 50
    Example: my_space-02
  • page_info string
    The unique identifier for pagination queries, used to locate a specific page.
    This parameter value is obtained from the link value in the response header of this API after you have queried the pagination information.
    For example, if the link value you obtained is <https://{handle}.myshopline.com/admin/openapi/{version}/metafield_definitions.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next" , the value of page_info is eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9 .
    For more information on how to use pagination, refer to Paging Mechanism.
  • since_id string
    The ID of a specific metafield definition. Start querying metafield definitions from this specified ID.
    Example: 45486331081
  • type string
    The data type for the metafield definition. Valid values are:
    • single_line_text_field: A single-line text field
    • list.single_line_text_field: Multiple single-line text fields
    • multi_line_text_field: Multi-line text field
    • color: A single color
    • list.color: Multiple colors
    • date: A single date
    • list.date: Multiple dates
    • date_time: A single date and time. Format: ISO 8601.
    • list.date_time: Multiple dates and times. Format: ISO 8601.
    • url: A single URL
    • list.url: Multiple URLs
    • file_reference: A single file. Support a PDF or image file within 10 MB. Supported image formats: JPG, JPEG, PNG, and GIF.
    • list.file_reference: Multiple files. Support PDF or image files and each file must be within 10 MB. Supported image formats: JPG, JPEG, PNG, and GIF.
    • json: JSON
    • weight: A single weight with a unit
    • list.weight: Multiple weights with units
    • volume: A single volume with a unit
    • list.volume: Multiple volumes with units
    • dimension: A single size with a unit
    • list.dimension: Multiple sizes with units
    • number_integer: A single integer
    • list.number_integer: Multiple integers
    • number_decimal: A single decimal
    • list.number_decimal: Multiple decimals
    • rating: A single rating
    • list.rating: Multiple ratings
    • page_reference: A single page
    • list.page_reference: Multiple pages
    • product_reference: A single product
    • list.product_reference: Multiple products
    • variant_reference: A single product variant
    • list.variant_reference: Multiple product variants
    • collection_reference: A single product collection
    • list.collection_reference: Multiple product collections
    • customer_reference: A single customer
    • list.customer_reference: Multiple customers
    • order_reference: A single order
    • list.order_reference: Multiple orders
    • boolean: Boolean type. Valid values are true and false.
    • money: Amount with a currency
    For more information about metafields, refer to Guide to Using Metafields Feature.
    Example: single_line_text_field
  • updated_at_max string
    Specify the cutoff update date for metafield definitions to query. Metafield definitions updated on and before this time are returned. Format: ISO 8601.
    Example: 2021-04-25T16:16:47+04:00
  • created_at_max string
    Specify the cutoff creation date and time for metafield definitions to query. Metafield definitions created on and before this time are returned. Format: ISO 8601.
    Example: 2021-04-25T16:16:47+04:00
Request Headers
  • Content-Type string required
    The field must be set to the fixed value application/json; charset=utf-8.
  • Authorization string required
    The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
Status Codes
For the complete list of codes and messages, see Http status code.
Response Headers
  • link
    The URL link that provides the pagination data. You can obtain page_info from this parameter for subsequent pagination requests.
    This parameter is returned when the requested page has a previous or next page.
    For more information on how to use pagination, refer to Paging Mechanism.
  • traceId
    A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.
Response Body
  • dataobject
    Response data.
  • metafield_definitionsobject[]
    List of metafield definitions.
  • accessobject
    Permission information for the metafield definition.
  • admin string
    The access permission for the metafield definition. Valid values are:
    • MERCHANT_READ_WRITE: Merchants can read and write.
    • MERCHANT_READ: Merchants have read-only access.
    • PUBLIC_READ: The public has read-only access.
    • PRIVATE: Accessible only to the current app.
    • NONE: No explicit permission set.
  • created_at string
    The date and time when the metafield definition was created. Format: ISO 8601.
  • description string
    The description of the metafield definition.
  • id long
    The ID of the metafield definition.
  • key string
    A unique identifier for a metafield definition within its namespace.
  • name string
    The name of the metafield definition.
  • namespace string
    The namespace of the metafield definition.
  • owner_resource string
    The type of the resource to which the metafield definition belongs. Valid values are:
    • products: products
    • variants: product variants
    • collections: product collections
    • customers: customers
    • orders: orders
    • pages: pages
    • blogs: blogs collections
    • articles: blogs
    • shop: store
  • type string
    The data type for the metafield definition. Valid values are:
    • single_line_text_field: A single-line text field
    • list.single_line_text_field: Multiple single-line text fields
    • multi_line_text_field: Multi-line text field
    • color: A single color
    • list.color: Multiple colors
    • date: A single date
    • list.date: Multiple dates
    • date_time: A single date and time. Format: ISO 8601.
    • list.date_time: Multiple dates and times. Format: ISO 8601.
    • url: A single URL
    • list.url: Multiple URLs
    • file_reference: A single file. Support a PDF or image file within 10 MB. Supported image formats: JPG, JPEG, PNG, and GIF.
    • list.file_reference: Multiple files. Support PDF or image files and each file must be within 10 MB. Supported image formats: JPG, JPEG, PNG, and GIF.
    • json: JSON
    • weight: A single weight with a unit
    • list.weight: Multiple weights with units
    • volume: A single volume with a unit
    • list.volume: Multiple volumes with units
    • dimension: A single size with a unit
    • list.dimension: Multiple sizes with units
    • number_integer: A single integer
    • list.number_integer: Multiple integers
    • number_decimal: A single decimal
    • list.number_decimal: Multiple decimals
    • rating: A single rating
    • list.rating: Multiple ratings
    • page_reference: A single page
    • list.page_reference: Multiple pages
    • product_reference: A single product
    • list.product_reference: Multiple products
    • variant_reference: A single product variant
    • list.variant_reference: Multiple product variants
    • collection_reference: A single product collection
    • list.collection_reference: Multiple product collections
    • customer_reference: A single customer
    • list.customer_reference: Multiple customers
    • order_reference: A single order
    • list.order_reference: Multiple orders
    • boolean: Boolean type. Valid values are true and false.
    • money: Amount with a currency
    For more information about metafields, refer to Guide to Using Metafields Feature.
  • updated_at string
    The date and time when the metafield definition was updated. Format: ISO 8601.
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— query required
— header required
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/metafield_definitions.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Examples
Get a list of metafield definitions
Response
{
  "data": {
    "metafield_definitions": [
      {
        "access": {
          "admin": "MERCHANT_READ"
        },
        "created_at": "2021-04-26T10:16:47-04:00",
        "description": "A list of ingredients used to make the product.",
        "id": 33646782314,
        "key": "key123",
        "name": "Ingredients",
        "namespace": "product_info",
        "owner_resource": "products",
        "type": "single_line_text_field",
        "updated_at": "2021-04-30T16:16:47-04:00"
      },
      {
        "access": {
          "admin": "PUBLIC_READ"
        },
        "created_at": "2021-05-01T08:10:23-04:00",
        "description": "Defines the warranty period for the product.",
        "id": 33646782315,
        "key": "warranty_period",
        "name": "Warranty",
        "namespace": "product_details",
        "owner_resource": "products",
        "type": "integer",
        "updated_at": "2021-05-05T16:16:47-04:00"
      }
    ]
  },
  "page_info": "eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9"
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.