Skip to main content

ObjectWithMetadata Interface

No description

interface ObjectWithMetadata {
  privateMetadata: [MetadataItem!]!
  privateMetafield(key: String!): String
  privateMetafields(keys: [String!]): Metadata
  metadata: [MetadataItem!]!
  metafield(key: String!): String
  metafields(keys: [String!]): Metadata
}

Fields​

privateMetadata ● [MetadataItem!]!​

List of private metadata items. Requires staff permissions to access.

privateMetafield ● String​

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!​

privateMetafields ● Metadata​

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

keys ● [String!]​

metadata ● [MetadataItem!]!​

List of public metadata items. Can be accessed without permissions.

metafield ● String​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!​

metafields ● Metadata​

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

keys ● [String!]​

Member Of​

DeleteMetadata object ● DeletePrivateMetadata object ● UpdateMetadata object ● UpdatePrivateMetadata object

Implemented By​

Address object ● App object ● Attribute object ● Category object ● Channel object ● Checkout object ● CheckoutLine object ● Collection object ● DigitalContent object ● Fulfillment object ● GiftCard object ● Invoice object ● Menu object ● MenuItem object ● Order object ● OrderLine object ● Page object ● PageType object ● Payment object ● Product object ● ProductMedia object ● ProductType object ● ProductVariant object ● Promotion object ● Sale object ● ShippingMethod object ● ShippingMethodType object ● ShippingZone object ● Shop object ● TaxClass object ● TaxConfiguration object ● TransactionItem object ● User object ● Voucher object ● Warehouse object