Add secondary resources

POST https://{handle}.myshopline.com/admin/openapi/v20250601/: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 .

[]

METAFIELD secondary resources new preservation

Path Parameters

owner_id string required
[]
Secondary resource id
p_owner_id string required
[]
First class resource id
p_resource string required
[]
First class resources , like products
resource string required
[]
Secondary resources such as variants

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

metafieldobject
[]
metafield
description string
[]
Description
[]
Example: Custom description
key string
[]
Key by value , 3-30 characters
[]
Example: key_123
namespace string
[]
Name space , 2-50 characters
[]
Example: namespace_123
type string
[]
The type of value, such as single_line_text_field, multi_line_text_field, boolean, url, variant_reference, product_reference, page_reference, rating, number_decimal, number_integer, dimension, volume, weight, json, file_reference, date_time, date, color
[]
Example: single_line_text_field
value object
[]
Value , type relies on type , default each application dispenses 100 m storage space，the maximum input length for a single metafield is 500,000 characters.
[]
Example: [object Object]

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

metafieldobject
[]
metafield
created_at string
[]
Creation time
[]
Example: 2022-12-28T09:39:35+00:00
description string
[]
Description
[]
Example: Custom description
id long
[]
Metafield's id
[]
Example: 124213413421342130
key string
[]
key
[]
Example: key_123
namespace string
[]
Name space
[]
Example: namespace_123
owner_id string
[]
Resources id
[]
Example: 18024213413413412341234
owner_resource string
[]
Resources
[]
Example: variants
type string
[]
Type
[]
Example: single_line_text_field
updated_at string
[]
Update time
[]
Example: 2022-12-28T09:39:35+00:00
value object
[]
value
[]
Example: [object Object]

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

owner_id — path required

p_owner_id — path required

p_resource — path required

resource — path required

Authorization — header required

Body

Body required

{
  "metafield": {
    "description": "Custom description",
    "key": "key_123",
    "namespace": "namespace_123",
    "type": "single_line_text_field",
    "value": {}
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/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' \
     --data '
{
  "metafield": {
    "description": "Custom description",
    "key": "key_123",
    "namespace": "namespace_123",
    "type": "single_line_text_field",
    "value": {}
  }
}
'

Was this article helpful to you?

SHOPLINE

Legal