Get order metafields
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/orders/example/metafields';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://apibase.ecomweb.app/api/v1/stores/example/orders/example/metafields \ --header 'x-api-key: <x-api-key>'Returns every metafield definition for this order with its current value, pinned definitions first and the rest by name. A definition without a value appears with value null, so the response also lists the metafields that can be set. For reference types, references says what each referenced ID points to.
Required scopes: read:orders
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The order ID.
The store’s ref, as returned by GET /stores.
Responses
Section titled “Responses”object
The metafield’s definition.
object
Definition ID, as a string.
The kind of resource the metafield attaches to.
What the metafield holds.
The value type: a base type such as single_line_text, or list. followed by a base type for a list of values.
The rules values must meet. Empty when the definition sets none.
object
Minimum text length, in characters. Text types.
Maximum text length, in characters. Text types and rich text.
A regular expression the text must match. Single-line text only, in a restricted dialect (no back-references or lookaround, at most 200 characters).
The only values allowed. Single-line text only, at most 128 choices.
Smallest allowed value: a number for integer, a decimal string for decimal, a date or date-time string, or a value with a unit for weight, volume and dimension.
object
The amount, as a decimal string.
The unit. Weights use g, kg, oz or lb; volumes ml, cl, l, m3, fl_oz, pt, qt or gal; dimensions mm, cm, m, in, ft or yd.
Maximum number of decimal places. Decimal only.
Host names a link may point to. Url and link types, at most 20.
Lowest rating on the scale, as a decimal string. Rating only.
Highest rating on the scale, as a decimal string. Rating only.
The kinds of file allowed. File type only.
ID of the metaobject definition an entry reference must belong to. Metaobject reference only.
IDs of the metaobject definitions a mixed reference may point to, between 2 and 10.
Minimum number of items. List types only.
Maximum number of items, at most 128. List types only.
What a signed-in customer may do with the values: none, read, or read_write. Only customer metafields allow read_write, and customer and order metafields allow read.
Position among the pinned definitions of its owner type, starting at 0, or null when the definition is not pinned.
ID of the user who created the definition, or null when it was created with an API key or the user has left.
When the definition was created, as an ISO 8601 timestamp.
When the definition was last updated, as an ISO 8601 timestamp.
Groups related metafields. Lowercase letters, digits and underscores; defaults to custom.
The metafield’s key within its namespace. Lowercase letters, digits and underscores.
Human-readable name.
Whether the storefront API exposes the values. Never available for customer, order and location metafields.
The definition’s namespace and key joined as namespace.key. Values are addressed by it.
For reference types, what each referenced ID points to, keyed by ID. Empty for other types.
object
object
Its image, when it has one.
ID of the referenced record.
Its name or title. Falls back to the ID when the record is missing.
True when the referenced record no longer exists.
Example
[ { "definition": { "owner_type": "product", "type": "single_line_text", "validations": { "file_types": [ "image" ] }, "customer_access": "none" } }]The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The resource does not exist in this store.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}