HomeDashboard
API Reference

Create a Metafield

post
https://api.ecartapi.com/api/v2/metafields

Create a new metafield attached to a store resource. Metafields are organized using a namespace and key pair — the namespace groups related metafields (e.g., your app name), and the key identifies the specific field within that group. The value type determines how the stored data is interpreted and validated.

Note: Each namespace + key combination must be unique per resource. Attempting to create a duplicate will return an error on most platforms.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Available platforms

This endpoint is supported by 1 platform. Click on the platform to see its specific required fields, value types, and resource scopes.

Shopify

Platform note. Metafields are currently available exclusively on Shopify. Each namespace + key combination must be unique per resource — attempting to create a duplicate will return a validation error.

Body Params

Metafield data to create.

string

Namespace for grouping related metafields. Typically your app name or integration identifier (e.g., my_app, b2b, inventory). Required.

string

Unique key within the namespace identifying this metafield (e.g., customer_tier, warehouse_code). Required.

string

The value to store. Must match the valueType format. Required.

string

Data type of the value. Accepted values: string, integer, json_string. Determines how the value is validated and rendered.

string

Human-readable description of what this metafield stores. Optional but recommended for documentation.

Response

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?