Get metafields of a resource (To be deprecated)

GET https://{handle}.myshopline.com/admin/openapi/v20260301/:p_resource/:p_owner_id/:resource/:owner_id/metafields.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 metafields for a resource.

DEPRECATED

This API is deprecated from API version v20250601. Use the Get metafields for a resource API instead.

Path Parameters

owner_id string required

Secondary resource id

Example: 1802351351232521351351
p_owner_id string required

First class resource id

Example: 16024213413413412341234
p_resource string required

First class resources , like products

Example: products
resource string required

Secondary resources such as variants

Example: variants

Query Parameters

created_at_min string

Show fields created after date

Example: 2021-04-25T16:15:47-04:00
limit string

Limited to quantity of limited to

Example: 30
type string

The data type for the metafield.

Example: single_line_text_field
updated_at_max string

Show updated field by date

Example: 2021-04-25T16:16:47-04:00
updated_at_min string

Show updated field after date

Example: 2021-04-25T16:15:47-04:00
fields string

Comma-separated list of fields to include in the response

Example: id,key
namespace string

namespace

Example: n_123
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}/:p_resource/:p_owner_id/:resource/:owner_id/metafields.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.

Example: 32fascxga32fasdf234234sdafsf
created_at_max string

Show fields created before date

Example: 2021-04-25T16:16:47-04:00
key string

A unique identifier for a metafield within its namespace.

Example: key_123
since_id string

After specify id , the result limited to

Example: 1

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

metafieldsobject[]

metafield
created_at string

created time
Example: 2022-12-28T09:48:09+00:00
description string

description
Example: 234212423
id long

metafield's id
Example: 398100698691
key string

A unique identifier for a metafield within its namespace.
Example: key_123
namespace string

Namespace
Example: n_123
owner_id string

Resource id
Example: 1802351351232521351351
owner_resource string

resources
Example: variants
type string

type
Example: single_line_text_field
updated_at string

updated time
Example: 2022-12-28T09:46:24+00:00
value object

The data stored in the metafield.

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

owner_id — path required

p_owner_id — path required

p_resource — path required

resource — path required

Authorization — header required

created_at_min — query

limit — query

type — query

updated_at_max — query

updated_at_min — query

fields — query

namespace — query

page_info — query

created_at_max — query

key — query

since_id — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/p_resource/p_owner_id/resource/owner_id/metafields.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal