Skip to main content
Anchor to CommentEventSubject

CommentEventSubject

interface

The subject line of a comment event.

Anchor to FieldsFields

Anchor to hasTimelineCommenthasTimelineComment
•Boolean!
non-null

Whether the timeline subject has a timeline comment. If true, then a timeline comment exists.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to CompanyCompany
•OBJECT

A business entity that purchases from the shop as part of B2B commerce. Companies organize multiple locations and contacts who can place orders on behalf of the organization. CompanyLocation objects can have custom pricing through Catalog and PriceList configurations.

Anchor to CompanyLocationCompanyLocation
•OBJECT

A location or branch of a Company that's a customer of the shop. Company locations enable B2B customers to manage multiple branches with distinct billing and shipping addresses, tax settings, and checkout configurations.

Each location can have its own Catalog objects that determine which products are published and their pricing. The BuyerExperienceConfiguration determines checkout behavior including PaymentTerms, and whether orders require merchant review. B2B customers select which location they're purchasing for, which determines the applicable catalogs, pricing, TaxExemption values, and checkout settings for their Order objects.

Anchor to CustomerCustomer
•OBJECT

Information about a customer of the shop, such as the customer's contact details, purchase history, and marketing preferences.

Tracks the customer's total spending through the amountSpent field and provides access to associated data such as payment methods and subscription contracts.

Caution

Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.

Anchor to DraftOrderDraftOrder
•OBJECT

An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:

  • Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created.
  • Send invoices to customers to pay with a secure checkout link.
  • Use custom items to represent additional costs or products that aren't displayed in a shop's inventory.
  • Re-create orders manually from active sales channels.
  • Sell products at discount or wholesale rates.
  • Take pre-orders.

For draft orders in multiple currencies presentment_money is the source of truth for what a customer is going to be charged and shop_money is an estimate of what the merchant might receive in their shop currency.

Caution: Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.

Draft orders created on or after April 1, 2025 will be automatically purged after one year of inactivity.

Anchor to InventoryTransferInventoryTransfer
•OBJECT

Tracks the movement of InventoryItem objects between Location objects. A transfer includes origin and destination information, InventoryTransferLineItem objects with quantities, and shipment details.

Transfers progress through multiple statuses. The transfer maintains LocationSnapshot objects of location details to preserve historical data even if locations change or are deleted later.

Anchor to OrderOrder
•OBJECT

The Order object represents a customer's request to purchase one or more products from a store. Use the Order object to handle the complete purchase lifecycle from checkout to fulfillment.

Use the Order object when you need to:

  • Display order details on customer account pages or admin dashboards.
  • Create orders for phone sales, wholesale customers, or subscription services.
  • Update order information like shipping addresses, notes, or fulfillment status.
  • Process returns, exchanges, and partial refunds.
  • Generate invoices, receipts, and shipping labels.

The Order object serves as the central hub connecting customer information, product details, payment processing, and fulfillment data within the GraphQL Admin API schema.

Note

Only the last 60 days' worth of orders from a store are accessible from the Order object by default. If you want to access older records, then you need to request access to all orders. If your app is granted access, then you can add the read_all_orders, read_orders, and write_orders scopes.

Caution

Only use orders data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.

Learn more about building apps for orders and fulfillment.

Anchor to PriceRulePriceRule
•OBJECT

A set of conditions, including entitlements and prerequisites, that must be met for a discount code to apply.

Note

Use the types and queries included our discount tutorials instead. These will replace the GraphQL Admin API's PriceRule object and DiscountCode union, and the REST Admin API's deprecatedPriceRule resource.

Was this section helpful?