Sign in Try for Free

Menu

Shopify Storefront actions

Pick an action to see its parameters, request body and response fields.

71 actions

Article · 1

QUERYarticleReturns an Article by its ID. Each article belongs to a Blog and includes content in both plain text and HTML formats, ArticleAuthor information, Comment objects, tags, and SEO data.

Articles · 1

QUERYarticlesReturns a paginated list of Article objects from the shop's Blog objects. Each article is a blog post containing content, author information, tags, and optional images.

Blog · 1

QUERYblogRetrieves a Blog by its handle or ID. A blog organizes Article objects for the online store and includes author information, SEO settings, and custom Metafield objects.

Blogs · 1

QUERYblogsReturns a paginated list of the shop's Blog objects. Each blog serves as a container for Article objects.

Cart · 26

QUERYcartFetch a cart by its ID — line items, cost, buyer identity, discount/gift-card codes, delivery groups, and the `checkoutUrl`.MUTATIONcartAttributesUpdateUpdates the attributes on a Cart. Attributes are custom key-value pairs that store additional information, such as gift messages, special instructions, or order notes.MUTATIONcartBillingAddressUpdateUpdates the billing address on the cart.MUTATIONcartBuyerIdentityUpdateUpdates the buyer identity on a Cart, including contact information, location, and checkout preferences.MUTATIONcartCloneCreates a clone of the specified cart with all personally identifiable information removed.QUERYcartCompletionAttemptA poll for the status of the cart checkout completion and order creation.MUTATIONcartCreateCreate a cart, optionally with line items, buyer identity, discount codes, gift cards and attributes; returns the cart and its `checkoutUrl`.MUTATIONcartDeliveryAddressesAddAdds delivery addresses to a Cart. A cart can have up to 20 delivery addresses.MUTATIONcartDeliveryAddressesRemoveRemoves delivery addresses from a Cart by their IDs, allowing batch removal in a single request.MUTATIONcartDeliveryAddressesReplaceReplaces all delivery addresses on a Cart with a new set of addresses in a single operation.MUTATIONcartDeliveryAddressesUpdateUpdates one or more delivery addresses on a Cart. Each address can be modified to change its details, set it as the pre-selected address for checkout, or mark it for one-time use so it isn't saved to the customer's…MUTATIONcartDiscountCodesUpdateUpdates the discount codes applied to a Cart. This mutation replaces all existing discount codes with the provided list, so pass an empty array to remove all codes.MUTATIONcartGiftCardCodesAddAdds gift card codes to a Cart without replacing any codes already applied. Gift card codes are case-insensitive.MUTATIONcartGiftCardCodesRemoveRemoves gift cards from a Cart using their IDs. You can retrieve the IDs of applied gift cards from the cart's appliedGiftCards field.MUTATIONcartGiftCardCodesUpdateUpdates the gift card codes applied to the cart. Unlike cartGiftCardCodesAdd, which adds codes without replacing existing ones, this mutation sets the gift card codes for the cart.MUTATIONcartLinesAddAdds one or more merchandise lines to an existing Cart. Each line specifies the product variant to purchase.MUTATIONcartLinesRemoveRemoves one or more merchandise lines from a Cart. Accepts up to 250 line IDs per request.MUTATIONcartLinesUpdateUpdates one or more merchandise lines on a Cart. You can modify the quantity, swap the merchandise, change custom attributes, or update the selling plan for each line.MUTATIONcartMetafieldDeleteDeletes a cart metafield. Note: This mutation won't trigger Shopify Functions.MUTATIONcartMetafieldsSetSets Metafield values on a cart, creating new metafields or updating existing ones. Accepts up to 25 metafields per request.MUTATIONcartNoteUpdateUpdates the note on a Cart. The note is a text field that stores additional information, such as a personalized message from the buyer or special instructions for the order.MUTATIONcartPaymentUpdateUpdate the customer's payment method that will be used to checkout.MUTATIONcartPrepareForCompletionValidate and lock a cart's contents/price ahead of submitting it for completion.MUTATIONcartRemovePersonalDataRemoves personally identifiable information from the cart.MUTATIONcartSelectedDeliveryOptionsUpdateUpdates the selected delivery option for one or more CartDeliveryGroup objects in a cart. Each delivery group represents items shipping to a specific address and offers multiple delivery options with different costs…MUTATIONcartSubmitForCompletionSubmit a prepared cart for order creation — returns a `cartCompletionAttempt` to poll.

Collection · 1

QUERYcollectionRetrieves a single Collection by its ID or handle. Use the products field to access items in the collection.

Collections · 1

QUERYcollectionsReturns a paginated list of the shop's collections. Each Collection object includes a nested connection to its products.

Customer · 16

QUERYcustomerRetrieves the Customer associated with the provided access token. Use the customerAccessTokenCreate mutation to obtain an access token using legacy customer account authentication (email and password).MUTATIONcustomerAccessTokenCreateExchange a customer's email + password for an access token (legacy customer accounts) — pass the token to the customer-scoped queries and mutations.MUTATIONcustomerAccessTokenCreateWithMultipassCreates a CustomerAccessToken using a multipass token instead of email and password. This enables single sign-on for customers who authenticate through an external system.MUTATIONcustomerAccessTokenDeletePermanently destroys a CustomerAccessToken. Use this mutation when a customer explicitly signs out or when you need to revoke the token.MUTATIONcustomerAccessTokenRenewExtends the validity of a CustomerAccessToken before it expires. The renewed token maintains authenticated access to customer operations.MUTATIONcustomerActivateActivates a customer account using an activation token received from the customerCreate mutation.MUTATIONcustomerActivateByUrlActivates a customer account using the full activation URL from the customerCreate mutation.MUTATIONcustomerAddressCreateCreates a new MailingAddress for a Customer. Use the customer's access token to identify them.MUTATIONcustomerAddressDeletePermanently deletes a specific MailingAddress for a Customer. Requires a valid customer access token to authenticate the request.MUTATIONcustomerAddressUpdateUpdates an existing MailingAddress for a Customer. Requires a customer access token to identify the customer, an ID to specify which address to modify, and an address with the updated fields.MUTATIONcustomerCreateCreates a new Customer account with the provided contact information and login credentials.MUTATIONcustomerDefaultAddressUpdateUpdates the default address of an existing Customer. Requires a customer access token to identify the customer and an address ID to specify which address to set as the new default.MUTATIONcustomerRecoverSends a reset password email to the customer. The email contains a reset password URL and token that you can pass to the customerResetByUrl or customerReset mutation to reset the customer's password.MUTATIONcustomerResetResets a customer's password using the reset token from a password recovery email. On success, returns the updated Customer and a new CustomerAccessToken for immediate authentication.MUTATIONcustomerResetByUrlResets a customer's password using the reset URL from a password recovery email. The reset URL is generated by the customerRecover mutation.MUTATIONcustomerUpdateUpdates a customer's personal information such as name, password, and marketing preferences.

Localization · 1

QUERYlocalizationThe store's available countries and languages and the currently-selected one — drives `@inContext` pricing and translation.

Locations · 1

QUERYlocationsReturns shop locations that support in-store pickup. Use the near argument with GeoCoordinateInput to sort results by proximity to the customer's location.

Menu · 1

QUERYmenuRetrieves a Menu by its handle. Menus are hierarchical navigation structures that merchants configure for their storefront, such as header and footer navigation.

Metaobject · 1

QUERYmetaobjectRetrieves a single Metaobject by either its global ID or its handle. Note: When using the handle, you must also provide the metaobject type because handles are only unique within a type.

Metaobjects · 1

QUERYmetaobjectsReturns a paginated list of Metaobject entries for a specific type. Metaobjects are custom data structures that extend Shopify's data model with merchant-defined or app-defined content like size charts, product…

Node · 1

QUERYnodeRetrieves any object that implements the Node interface by its globally-unique ID. Use inline fragments to access type-specific fields on the returned object.

Nodes · 1

QUERYnodesRetrieves multiple objects by their global IDs in a single request. Any object that implements the Node interface can be fetched, including products, collections, and pages.

Page · 1

QUERYpageRetrieves a Page by its handle or id. Pages are static content pages that merchants display outside their product catalog, such as "About Us," "Contact," or policy pages.

Pages · 1

QUERYpagesReturns a paginated list of the shop's content pages. Pages are custom HTML content like "About Us", "Contact", or policy information that merchants display outside their product catalog.

Payment · 1

QUERYpaymentSettingsThe store's accepted card brands, digital wallets, supported countries, and Shopify Payments account id — for building a custom checkout.

Predictive · 1

QUERYpredictiveSearchSearch-as-you-type results across products, collections, pages, articles and queries from a partial term.

Product · 4

QUERYproductRetrieves a single Product by its ID or handle. Use this query to build product detail pages, access variant and pricing information, or fetch product media and metafields.QUERYproductRecommendationsReturns recommended products for a given product, identified by either ID or handle. Use the intent argument to control the recommendation strategy.QUERYproductTagsReturns a paginated list of all tags that have been added to products in the shop. Useful for building tag-based product filtering or navigation in a storefront.QUERYproductTypesReturns a list of product types from the shop's Product objects that are published to your app.

Products · 1

QUERYproductsReturns a paginated list of the shop's products. For full-text storefront search, use the search query instead.

Public · 1

QUERYpublicApiVersionsReturns all public Storefront API versions, including supported, release candidate, and unstable versions.

Search · 1

QUERYsearchFull storefront search across products (with filters/facets) and, optionally, articles and pages.

Shop · 3

QUERYshopReturns the Shop associated with the storefront access token. The Shop object provides general store information such as the shop name, description, and primary domain.MUTATIONshopPayPaymentRequestSessionCreateCreates a Shop Pay payment request session for processing payments. The session includes a checkout URL where customers complete their purchase and a token for subsequent operations like submitting the payment.MUTATIONshopPayPaymentRequestSessionSubmitFinalizes a Shop Pay payment request session. Call this mutation after creating a session with shopPayPaymentRequestSessionCreate.

Sitemap · 1

QUERYsitemapReturns sitemap data for a specific resource type, enabling headless storefronts to generate XML sitemaps for search engine optimization.

Url · 1

QUERYurlRedirectsReturns a paginated list of UrlRedirect objects configured for the shop. Each redirect maps an old path to a target location.

Shopify Storefront actions — Documentation