interface
Represents information about the metafields associated to the specified resource.
Fields and connections
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.A list of custom fields that a merchant associates with a Shopify resource.
The metafields associated with the resource matching the supplied list of namespaces and keys.
Types implemented in
Represents an installed application on a shop.
An article in the blogging system.
Shopify stores come with a built-in blogging engine, allowing a shop to have one or more blogs. Blogs are meant to be used as a type of magazine or newsletter for the shop, with content that changes over time.
Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.
Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.
Collections can also be created for a custom group of products. These are called custom or manual collections.
Represents information about a company which is also a customer of the shop.
A location or branch of a company that's a customer of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location.
Represents information about a customer of the shop, such as the customer's contact details, their order history, and whether they've agreed to receive marketing material by email.
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.
A delivery customization.
The delivery method used by a fulfillment order.
A node containing an automatic discount and its related events.
A node containing a code discount and its related events.
A discount wrapper node.
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.
- Save an order as a draft and resume working on it later.
For draft orders in multiple currencies
is the source of truth for what a customer is going to be charged and
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.
Represents a gate configuration, which stores the information about a gate. A gate configuration can be bound to multiple subjects via the GateSubject model.
Represents an image resource.
Represents the location where the physical good resides.
A market is a group of one or more regions that you want to target for international sales. By creating a market, you can configure a distinct, localized shopping experience for customers from a specific area of the world. For example, you can change currency, configure international pricing, or add market-specific domains or subfolders.
An image hosted on Shopify.
An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the
Order
object. Learn more about editing an existing order with the GraphQL Admin API.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 orders, then you need to request access to all orders. If your app is granted access, then you can add thescope to your app along with
or
. Private apps are not affected by this change and are automatically granted the scope.
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.
A page on the Online Store.
A payment customization.
The
Product
object lets you manage products in a merchant’s store.Products are the goods and services that merchants offer to customers. They can include various details such as title, description, price, images, and options such as size or color. You can use product variants to create or update different versions of the same product. You can also add or update product media. Products can be organized by grouping them into a collection.
Learn more about working with Shopify's product model, including limitations and considerations.
Represents a product variant.
Represents how a product can be sold and purchased. Selling plans and associated records (selling plan groups and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later.
For more information on selling plans, refer to Creating and managing selling plans.
Represents a collection of general settings and information about the shop.