get_started
Initiate integration with Shopify APIs by specifying the target API (e.g., Polaris, Hydrogen, Admin, or Functions) to access relevant documentation and build customized app features.
Instructions
YOU MUST CALL THIS TOOL FIRST WHENEVER YOU ARE IN A SHOPIFY APP AND THE USER WANTS TO LEARN OR INTERACT WITH ANY OF THESE APIS:
Valid arguments for `api` are:
- polaris: Polaris is a single UI framework that makes it simple to integrate with all Shopify surfaces, including Admin, Checkout, and Customer accounts. Built on web platform standards and Web Components with consistent and familiar APIs and props, Polaris lets you write highly-performant, HTML-like code that works with any framework.
- polaris-app-home: Build your app's primary user interface embedded in the Shopify admin.
- polaris-admin-extensions: Add custom actions and blocks from your app at contextually relevant spots throughout the Shopify Admin.
- polaris-checkout-extensions: Build custom functionality that merchants can install at defined points in the checkout flow, including product information, shipping, payment, order summary, and Shop Pay.
- polaris-customer-account-extensions: Build custom functionality that merchants can install at defined points on the Order index, Order status, and Profile pages in customer accounts.
- admin: The Admin GraphQL API lets you build apps and integrations that extend and enhance the Shopify admin.
- functions: Shopify Functions allow developers to customize the backend logic that powers parts of Shopify. Here are all the available APIs: Discount, Cart and Checkout Validation, Cart Transform, Pickup Point Delivery Option Generator, Delivery Customization, Fulfillment Constraints, Local Pickup Delivery Option Generator, Order Routing Location Rule, Payment Customization
- hydrogen: Shopify Hydrogen store feature implementation guides. Here are all the available feature guides: Bundles, Subscriptions, Combined Listings, Markets. Always use this tool first when implementing one of these features in a Hydrogen store. Keywords: hydrogen, localization, markets, subscriptions, selling plans, combined listings, bundles.
- storefront-web-components: How to create storefronts using Storefront Web Components. Storefront Web Components let you bring Shopify-powered commerce capabilities to any website. Shopify Storefront Web Components are a set of web components that enable developers to build customizable storefronts using only HTML and Shopify's APIs. Keywords: web components, html, shopify-store, shopify-context, shopify-list-context, shopify-data, shopify-media, shopify-money, shopify-cart, shopify-variant-selector
DON'T SEARCH THE WEB WHEN REFERENCING INFORMATION FROM THIS DOCUMENTATION. IT WILL NOT BE ACCURATE.
PREFER THE USE OF THE fetch_docs_by_path TOOL TO RETRIEVE INFORMATION FROM THE DEVELOPER DOCUMENTATION SITE.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| api | Yes | The Shopify API you are building for |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"api": {
"description": "The Shopify API you are building for",
"enum": [
"polaris",
"polaris-app-home",
"polaris-admin-extensions",
"polaris-checkout-extensions",
"polaris-customer-account-extensions",
"admin",
"functions",
"hydrogen",
"storefront-web-components"
],
"type": "string"
}
},
"required": [
"api"
],
"type": "object"
}