Skip to main content
Glama

Get a Shopify Record

shopify_get
Read-onlyIdempotent

Retrieve a single Shopify record by GID from a specified store, including products, orders, customers, inventory, metafields, theme files, or discounts.

Instructions

Read one record by GID from one store. Follow each returned cursor independently. Resources:

  • product: Product details, variants (first/after) and media (mediaAfter). id: Product GID.

  • collection: Collection details, rules and a page of products. id: Collection GID.

  • order: Order, shipping, fulfillment, tracking and a page of line items. id: Order GID.

  • inventory: Inventory by product (id: Product GID) or inventory item (id: InventoryItem GID, pages through locations).

  • metafields: Metafields of any owner (id: owner GID); optional namespace and key.

  • theme_files: Theme file contents. id: OnlineStoreTheme GID; optional filenames, else pages through every file.

  • blog_articles: A blog's articles. id: Blog GID.

  • uploaded_image: Image processing status and CDN URL. id: MediaImage GID.

  • bulk_operation: A bulk operation's status and result URLs. id: BulkOperation GID. Partial exports stay marked incomplete.

  • customer: Customer details, addresses, marketing consent state and a page of orders, newest first. id: Customer GID.

  • draft_order: Draft order with status, totals, addresses and line items. id: DraftOrder GID.

  • variants: Every variant field of a product (price, barcode, tax, inventory policy, weight, cost, origin, HS code, options) with first/after. id: Product GID.

  • order_transactions: An order's payment transactions (authorizations, captures, refunds, voids). id: Order GID.

  • order_refunds: An order's refunds with refunded items, restock status and transactions. id: Order GID.

  • fulfillment_orders: An order's fulfillment orders with status, location, delivery method, holds and line items. id: Order GID.

  • webhook: One webhook subscription of this app. id: WebhookSubscription GID.

  • page: One Online Store page with its HTML body, handle, isPublished, publishedAt and templateSuffix. id: Page GID.

  • article: One blog article with body, summary, author, tags, image, isPublished, publishedAt and its blog. id: Article GID.

  • metaobject: One metaobject: handle, type, displayName, fields (key, type, value, jsonValue), updatedAt, capabilities. id: Metaobject GID.

  • metaobject_definition: One metaobject definition with full field definitions and validations. id: MetaobjectDefinition GID.

  • fulfillment: One fulfillment: status, tracking info (company, number, url), line items, location and createdAt. id: Fulfillment GID (from the order's fulfillments).

  • discount: One discount in full: status, summary, dates, value, minimum requirement, who is eligible, items it covers, combinesWith, usage limits and usage, and the first 20 codes with a code count. id: DiscountNode, DiscountCodeNode or DiscountAutomaticNode GID.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "resource": "<resource>",
      "store": "<store>",
      "id": "<id>"
    },
    "name": "shopify_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe record's GID, such as gid://shopify/Product/123.
keyNometafields: only this key.
afterNo
firstNo
storeYes
resourceYes
filenamesNotheme_files: only these files.
namespaceNometafields: only this namespace.
mediaAfterNoproduct: cursor for the media page.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.2.0
    • changedInput schema / properties / resource / enum
      Previous value: -[
      -  "product",
      -  "collection",
      -  "order",
      -  "inventory",
      -  "metafields",
      -  "theme_files",
      -  "blog_articles",
      -  "uploaded_image",
      -  "bulk_operation"
      -]New value: +[
      +  "product",
      +  "collection",
      +  "order",
      +  "inventory",
      +  "metafields",
      +  "theme_files",
      +  "blog_articles",
      +  "uploaded_image",
      +  "bulk_operation",
      +  "customer",
      +  "draft_order",
      +  "variants",
      +  "order_transactions",
      +  "order_refunds",
      +  "fulfillment_orders",
      +  "webhook",
      +  "page",
      +  "article",
      +  "metaobject",
      +  "metaobject_definition",
      +  "fulfillment",
      +  "discount"
      +]
  2. Addedv2.0.1

TDQS

A3.8/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already cover read-only, idempotent, open-world and non-destructive behavior, yet the description adds real context: independent per-cursor paging, default full-page behavior for theme_files and inventory locations, the 'Partial exports stay marked incomplete' caveat for bulk_operation, and the 20-code cap with count for discount. It does not cover auth scopes or error behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the one-line purpose, then a dense resource list where nearly every bullet earns its place by naming the ID type and returned fields. The cursor sentence is slightly orphaned and the list is long, but length is justified by 22 resources.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description carries the return-value burden and does so resource by resource, including ordering notes ('newest first') and completeness flags. Remaining gaps are error handling and auth requirements for a 9-parameter tool with an enum.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is only 56%, and the description compensates heavily: it maps each resource to the required GID type, explains namespace/key as metafield filters, explains filenames as an alternative to paging every theme file, and ties mediaAfter to the product media page. It omits guidance on `first` limits and `after` semantics generally.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and scope ('Read one record by GID from one store') and enumerates all 22 supported resources with the GID type each expects, which is far more specific than the name alone. It does not explicitly distinguish itself from siblings like shopify_search or shopify_graphql_query, so an agent must infer that split.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

'Follow each returned cursor independently' gives pagination guidance, and per-resource id lines imply which GID to supply. However there is no explicit statement of when to use this versus shopify_search or shopify_graphql_query, and no prerequisites or exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.