Skip to main content
Version: 3.x

ObjectWithMetadata

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​

ObjectWithMetadata.privateMetadata ● [MetadataItem!]! non-null object​

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

ObjectWithMetadata.privateMetafield ● String scalar​

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

Tip: Use GraphQL aliases to fetch multiple keys.

ObjectWithMetadata.privateMetafield.key ● String! non-null scalar​

ObjectWithMetadata.privateMetafields ● Metadata scalar​

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

ObjectWithMetadata.privateMetafields.keys ● [String!] list scalar​

ObjectWithMetadata.metadata ● [MetadataItem!]! non-null object​

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

ObjectWithMetadata.metafield ● String scalar​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

ObjectWithMetadata.metafield.key ● String! non-null scalar​

ObjectWithMetadata.metafields ● Metadata scalar​

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

ObjectWithMetadata.metafields.keys ● [String!] list scalar​

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

Was this page helpful?