Shopify website screenshot

Shopify

Shopify is a complete commerce platform that lets you start, grow, and manage a business. The Shopify API lets you build apps and integrations that extend Shopify functionality for merchants.

20 APIs 15 Features
CommerceEcommercePaymentsRetailShopping CartT1

APIs

Shopify Admin REST API

The Shopify Admin REST API lets you build apps and integrations that extend and enhance the Shopify admin. It provides access to products, customers, orders, inventory, fulfillm...

Shopify GraphQL Admin API

The GraphQL Admin API lets you build apps and integrations that extend and enhance the Shopify admin. It provides access to products, customers, orders, inventory, fulfillment, ...

Shopify Storefront API

The Storefront API is a GraphQL API that provides commerce primitives to build custom, scalable, and performant shopping experiences on any platform, including the web, apps, an...

Shopify Customer Account API

The Customer Account API offers a secure way to access private customer-scoped data, enabling you to build personalized, customer-authenticated experiences in your custom storef...

Shopify Partner API

The Partner API provides access to data in the Partners Dashboard, including transactions that impact your earnings, app events, and for participating partners, Experts Marketpl...

Shopify Payments Apps API

The Payments Apps API enables approved Shopify Payments Partners to access their Shopify Payments account and payments app configuration data. It provides access to payment sess...

Shopify Ajax API

The Ajax API provides a suite of lightweight REST API endpoints for development of Shopify themes. It is an unauthenticated API used to add products to the cart, display product...

Shopify Liquid API

Liquid is a template language created by Shopify and available as an open source project on GitHub. The Liquid reference documents the tags, filters, and objects that you can us...

Shopify Functions API

Shopify Functions allow developers to customize the backend logic that powers parts of Shopify. Functions are compiled to WebAssembly and enable custom discounts, payment custom...

Shopify Discount Function API

The Discount Function API enables developers to create a single discount that applies to cart lines, order subtotals, and shipping rates. It replaces the previous separate Produ...

Shopify Webhooks API

Shopify webhooks enable apps to receive notifications about particular events in a shop. They are useful for keeping your app in sync with Shopify data or as a trigger to perfor...

Shopify App Bridge

Shopify App Bridge enables apps to render UI in the Shopify app home surface and seamlessly integrate with the Shopify admin. It provides APIs for navigation menus, save bars, t...

Shopify App Home API

The App Home API provides the surface where apps render their main UI within the Shopify admin. It supports Polaris web components for building consistent, accessible interfaces...

Shopify Checkout UI Extensions API

Checkout UI extensions let app developers build custom functionality that merchants can install at defined points in the checkout flow, including product information, shipping, ...

Shopify Multipass API

Multipass login is for store owners who have a separate website and a Shopify store, enabling seamless single sign-on by redirecting users and automatically logging them in. Req...

Shopify POS UI Extensions API

POS UI extensions enable app developers to build custom functionality for Shopify Point of Sale. Extensions can add functionality to the cart, post- purchase, and other POS surf...

Shopify Admin Extensions API

Admin UI extensions allow developers to extend the Shopify admin with custom UI components. Extensions can render in product details, order details, customer details, and other ...

Shopify Hydrogen

Hydrogen is Shopify's React-based framework for building custom storefronts powered by the Storefront API. It provides commerce-optimized components, hooks, and utilities for bu...

Shopify Polaris

Polaris is Shopify's unified UI framework built on web components for delivering a consistent experience across the platform. It provides a library of UI components, tokens, and...

Shopify CLI

Shopify CLI is a command-line tool that helps developers create Shopify apps, themes, and custom storefronts. It accelerates development with scaffolding, local development serv...

Collections

Shopify API

POSTMAN

Arazzo Workflows

Shopify Add a Variant to an Existing Product

Confirm a product exists, add a new variant to it, then read the variant list back.

ARAZZO

Shopify Archive a Stale Product

Read a product and branch on its status, archiving it only when it is still active.

ARAZZO

Shopify Cancel and Restock an Order

Confirm an order, cancel it with a reason and restock, then read the cancelled order back.

ARAZZO

Shopify Tag and Close an Order

Tag an order, close it to mark it completed, then read the closed order back.

ARAZZO

Shopify Create Collection With a Product

Create a custom collection, confirm a product, then read the collection back.

ARAZZO

Shopify Create Customer With Address

Create a customer record, attach a mailing address, then read the customer back.

ARAZZO

Shopify Create Order and Fulfill

Place an order, locate its fulfillment order, create a fulfillment with tracking, and read the order back.

ARAZZO

Shopify Create Product With Variant

Create a product, add a priced variant to it, then read the finished product back.

ARAZZO

Shopify Find Collection and List Its Products

Find a custom collection by title, then list the products it contains.

ARAZZO

Shopify Fulfill an Existing Order

Resolve an order's fulfillment order, create a fulfillment with tracking, and confirm the result.

ARAZZO

Shopify Launch a Product With Stock

Create a product, add a variant, resolve a location, and set its starting inventory.

ARAZZO

Shopify Quote to Paid Order

Create a pending (quote-style) order, mark it paid, then read the completed order back.

ARAZZO

Shopify Register a Webhook Subscription

Create a webhook subscription for a topic, then read it back to confirm registration.

ARAZZO

Shopify Restock a Product Variant

Read a variant to find its inventory item, resolve a location, and set the available quantity.

ARAZZO

Shopify Set Inventory at a Location

Resolve the primary location, set an item's available quantity there, then verify the new level.

ARAZZO

Shopify Tag an Order by Fulfillment Status

Read an order and branch on its fulfillment status to apply the appropriate tag.

ARAZZO

Shopify Update Fulfillment Tracking

Confirm an order, update a fulfillment's tracking details, then read the order back.

ARAZZO

Shopify Update an Inventory Item Cost

Read an inventory item, update its unit cost and tracking flag, then read it back.

ARAZZO

Shopify Upsert a Customer by Email

Search for a customer by email and update it if it exists, otherwise create it.

ARAZZO

Shopify Upsert Customer Then Place Order

Find or create a customer by email, then place an order for that customer.

ARAZZO

Shopify Upsert a Product by Title

Find a product by exact title and update it if it exists, otherwise create it.

ARAZZO

Shopify Upsert a Webhook by Topic

Find a webhook subscription for a topic and update its address if it exists, otherwise create it.

ARAZZO

GraphQL

Shopify GraphQL API

The GraphQL Admin API lets you build apps and integrations that extend and enhance the Shopify admin. It provides access to products, customers, orders, inventory, fulfillment, ...

GRAPHQL

Pricing Plans

Shopify Plans Pricing

4 plans

PLANS

Rate Limits

Shopify Rate Limits

5 limits

RATE LIMITS

FinOps

Features

REST Admin API with leaky-bucket throttling (40 req/app/store)
GraphQL Admin API with cost-based throttling (1,000 pts on Standard, 2,000 on Plus)
Storefront API for headless commerce
Plans: Basic ($29), Grow ($79), Advanced ($299), Plus ($2,300)
Online card transaction fees from 2.25% (Plus) to 2.9% (Basic)
Third-party gateway fees from 0% (Plus) to 2% (Basic)
AI assistant for commerce included on all plans
Up to 200 POS Pro locations on Plus
B2B / wholesale on Plus
Customizable checkout on Plus
Bulk operations for large data exports without rate-limit hits
Webhooks for order, customer, inventory, and product events
OAuth 2.0 app authentication
Shopify Functions for backend customization
Shopify Markets for region-specific currencies and pricing

Semantic Vocabularies

Shopify Context

75 classes · 29 properties

JSON-LD

API Governance Rules

Shopify API Rules

13 rules · 4 errors 5 warnings 4 info

SPECTRAL

JSON Structure

Shopify Order Structure

0 properties

JSON STRUCTURE

Shopify Product Structure

0 properties

JSON STRUCTURE

Example Payloads

Shopify List Orders Example

4 fields

EXAMPLE

Visuals

View API subway map

Resources

🔗
PostmanWorkspace
PostmanWorkspace
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
LinkedIn
LinkedIn
🔗
Documentation
Documentation
🔗
Versioning
Versioning
🔑
Authentication
Authentication
🔗
CLI
CLI
🔗
Documentation
Documentation
🌐
Portal
Portal
📦
SDKs
SDKs
🔗
RateLimits
RateLimits
📄
ChangeLog
ChangeLog
🔗
Versioning
Versioning
🟢
StatusPage
StatusPage
💬
Support
Support
📜
TermsOfService
TermsOfService
📜
PrivacyPolicy
PrivacyPolicy
📝
Signup
Signup
🔗
Webhooks
Webhooks
🔗
Security
Security
🔗
Access Scopes
Access Scopes
🔗
Forums
Forums
👥
GitHubOrganization
GitHubOrganization
📰
Blog
Blog
🔗
Headless
Headless
📝
Design System
Design System
🔗
App Bridge
App Bridge
🔗
Application Marketplace
Application Marketplace
🔗
Partner Program
Partner Program
👥
YouTube
YouTube
🚀
GettingStarted
GettingStarted
🔗
Extensions
Extensions
🔗
Themes
Themes
👥
StackOverflow
StackOverflow
🔗
Website
Website
🔗
Login
Login
🔗
Community
Community
📄
ChangeLog
ChangeLog
📦
SDKs
SDKs
📦
SDKs
SDKs
🔗
LlmsText
LlmsText

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Shopify Webhooks API
  version: 2025-01
request:
  auth:
    type: apikey
    key: X-Shopify-Access-Token
    value: '{{X-Shopify-Access-Token}}'
    placement: header
items:
- info:
    name: Webhook Subscriptions
    type: folder
  items:
  - info:
      name: Shopify Retrieve a list of webhook subscriptions
      type: http
    http:
      method: GET
      url: https://{store}.myshopify.com/admin/api/2025-01/webhooks.json
      params:
      - name: topic
        value: ''
        type: query
        description: Filter by webhook topic (e.g. orders/create)
      - name: address
        value: ''
        type: query
        description: Filter by callback address
      - name: created_at_min
        value: ''
        type: query
        description: Show webhooks created after this date
      - name: created_at_max
        value: ''
        type: query
        description: Show webhooks created before this date
      - name: updated_at_min
        value: ''
        type: query
        description: Show webhooks updated after this date
      - name: updated_at_max
        value: ''
        type: query
        description: Show webhooks updated before this date
      - name: limit
        value: ''
        type: query
        description: Maximum number of results (max 250, default 50)
      - name: since_id
        value: ''
        type: query
        description: Return webhooks after the specified ID
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include
    docs: Retrieves a list of webhooks for the authenticated app. Filter by topic, creation date, or other criteria.
  - info:
      name: Shopify Create a webhook subscription
      type: http
    http:
      method: POST
      url: https://{store}.myshopify.com/admin/api/2025-01/webhooks.json
      body:
        type: json
        data: '{}'
    docs: Creates a new webhook subscription. When the specified event occurs Shopify sends an HTTP POST to the provided callback
      address with the event payload in JSON or XML format.
  - info:
      name: Shopify Retrieve a count of webhook subscriptions
      type: http
    http:
      method: GET
      url: https://{store}.myshopify.com/admin/api/2025-01/webhooks/count.json
      params:
      - name: topic
        value: ''
        type: query
        description: Count webhooks for a specific topic
      - name: address
        value: ''
        type: query
        description: Count webhooks for a specific address
    docs: Retrieves a count of webhook subscriptions for the authenticated app.
  - info:
      name: Shopify Retrieve a single webhook subscription
      type: http
    http:
      method: GET
      url: https://{store}.myshopify.com/admin/api/2025-01/webhooks/:webhook_id.json
      params:
      - name: webhook_id
        value: ''
        type: path
        description: The ID of the webhook subscription
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include
    docs: Retrieves a webhook subscription by its ID.
  - info:
      name: Shopify Update a webhook subscription
      type: http
    http:
      method: PUT
      url: https://{store}.myshopify.com/admin/api/2025-01/webhooks/:webhook_id.json
      params:
      - name: webhook_id
        value: ''
        type: path
        description: The ID of the webhook subscription
      body:
        type: json
        data: '{}'
    docs: Updates an existing webhook subscription. The address and fields can be modified but the topic cannot be changed.
  - info:
      name: Shopify Delete a webhook subscription
      type: http
    http:
      method: DELETE
      url: https://{store}.myshopify.com/admin/api/2025-01/webhooks/:webhook_id.json
      params:
      - name: webhook_id
        value: ''
        type: path
        description: The ID of the webhook subscription
    docs: Deletes a webhook subscription by its ID.
bundled: true