Shopify Admin API

The Shopify Admin API provides programmatic access to manage Shopify store administration. It enables app developers and merchants to manage products, customers, orders, inventory, shipping, fulfillment, collections, webhooks, and store settings. The Admin API is available in both REST and GraphQL formats. Shopify is transitioning from REST to GraphQL as the primary API, with GraphQL recommended for all new development.

3 APIs 0 Features

CommerceEcommerceAdminProductsOrdersCustomers

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 Admin GraphQL API

The Shopify Admin GraphQL API is the recommended API for building Shopify apps and integrations. It provides access to all Shopify admin resources including products, customers,...

Shopify Webhooks

Shopify webhooks allow apps to subscribe to specific events that occur in a store. When an event occurs, Shopify sends an HTTP POST request with a JSON payload to the configured...

Collections

Shopify Admin REST API

OPEN

GraphQL

Shopify Admin API GraphQL API

The Shopify Admin GraphQL API is the recommended API for building Shopify apps and integrations. It provides access to all Shopify admin resources including products, customers,...

GRAPHQL

Pricing Plans

Shopify Admin Plans Pricing

5 plans

PLANS

Rate Limits

Shopify Admin Rate Limits

13 limits

RATE LIMITS

FinOps

Shopify Admin Finops

FINOPS

Event Specifications

Shopify Admin Webhooks

AsyncAPI 2.6 specification modeling the Shopify Admin webhook event surface. Shopify webhooks allow apps to subscribe to events that occur in a Shopify store. When a subscribed ...

ASYNCAPI

Semantic Vocabularies

Shopify Admin Context

41 classes · 3 properties

JSON-LD

API Governance Rules

Shopify Admin API API Rules

9 rules · 3 errors 5 warnings 1 info

SPECTRAL

JSON Structure

Shopify Admin Product Structure

0 properties

JSON STRUCTURE

Example Payloads

Shopify Admin Create Order Example

4 fields

EXAMPLE

Shopify Admin List Products Example

4 fields

EXAMPLE

Resources

Sources

opencollection: 1.0.0
info:
  name: Shopify Admin REST API
  version: 2024-10
request:
  auth:
    type: apikey
    key: X-Shopify-Access-Token
    value: '{{X-Shopify-Access-Token}}'
    placement: header
items:
- info:
    name: Products
    type: folder
  items:
  - info:
      name: List Products
      type: http
    http:
      method: GET
      url: https://{store_name}.myshopify.com/admin/api/2024-10/products.json
      params:
      - name: limit
        value: ''
        type: query
        description: The maximum number of results to show (maximum 250, default 50)
      - name: page_info
        value: ''
        type: query
        description: A unique ID used to access a specific page in results
      - name: ids
        value: ''
        type: query
        description: Show only products specified by a comma-separated list of IDs
      - name: status
        value: ''
        type: query
        description: Filter by product status
    docs: Retrieves a list of products from the store.
  - info:
      name: Create Product
      type: http
    http:
      method: POST
      url: https://{store_name}.myshopify.com/admin/api/2024-10/products.json
      body:
        type: json
        data: '{}'
    docs: Creates a new product in the store.
  - info:
      name: Get Product
      type: http
    http:
      method: GET
      url: https://{store_name}.myshopify.com/admin/api/2024-10/products/:product_id.json
      params:
      - name: product_id
        value: ''
        type: path
        description: The ID of the product
    docs: Retrieves a single product by ID.
  - info:
      name: Update Product
      type: http
    http:
      method: PUT
      url: https://{store_name}.myshopify.com/admin/api/2024-10/products/:product_id.json
      params:
      - name: product_id
        value: ''
        type: path
        description: The ID of the product
      body:
        type: json
        data: '{}'
    docs: Updates an existing product.
  - info:
      name: Delete Product
      type: http
    http:
      method: DELETE
      url: https://{store_name}.myshopify.com/admin/api/2024-10/products/:product_id.json
      params:
      - name: product_id
        value: ''
        type: path
        description: The ID of the product
    docs: Deletes a product from the store.
- info:
    name: Customers
    type: folder
  items:
  - info:
      name: List Customers
      type: http
    http:
      method: GET
      url: https://{store_name}.myshopify.com/admin/api/2024-10/customers.json
      params:
      - name: limit
        value: ''
        type: query
        description: The maximum number of results to show
      - name: email
        value: ''
        type: query
        description: Filter customers by email address
    docs: Retrieves a list of customers from the store.
  - info:
      name: Create Customer
      type: http
    http:
      method: POST
      url: https://{store_name}.myshopify.com/admin/api/2024-10/customers.json
      body:
        type: json
        data: '{}'
    docs: Creates a new customer account.
  - info:
      name: Get Customer
      type: http
    http:
      method: GET
      url: https://{store_name}.myshopify.com/admin/api/2024-10/customers/:customer_id.json
      params:
      - name: customer_id
        value: ''
        type: path
        description: The ID of the customer
    docs: Retrieves a single customer by ID.
  - info:
      name: Update Customer
      type: http
    http:
      method: PUT
      url: https://{store_name}.myshopify.com/admin/api/2024-10/customers/:customer_id.json
      params:
      - name: customer_id
        value: ''
        type: path
        description: The ID of the customer
      body:
        type: json
        data: '{}'
    docs: Updates an existing customer.
- info:
    name: Orders
    type: folder
  items:
  - info:
      name: List Orders
      type: http
    http:
      method: GET
      url: https://{store_name}.myshopify.com/admin/api/2024-10/orders.json
      params:
      - name: limit
        value: ''
        type: query
        description: The maximum number of results to show
      - name: status
        value: ''
        type: query
        description: Filter orders by status
      - name: financial_status
        value: ''
        type: query
        description: Filter orders by financial status
      - name: fulfillment_status
        value: ''
        type: query
        description: Filter orders by fulfillment status
    docs: Retrieves a list of orders from the store.
  - info:
      name: Get Order
      type: http
    http:
      method: GET
      url: https://{store_name}.myshopify.com/admin/api/2024-10/orders/:order_id.json
      params:
      - name: order_id
        value: ''
        type: path
        description: The ID of the order
    docs: Retrieves a single order by ID.
  - info:
      name: Update Order
      type: http
    http:
      method: PUT
      url: https://{store_name}.myshopify.com/admin/api/2024-10/orders/:order_id.json
      params:
      - name: order_id
        value: ''
        type: path
        description: The ID of the order
      body:
        type: json
        data: '{}'
    docs: Updates an existing order.
  - info:
      name: Cancel Order
      type: http
    http:
      method: POST
      url: https://{store_name}.myshopify.com/admin/api/2024-10/orders/:order_id/cancel.json
      params:
      - name: order_id
        value: ''
        type: path
        description: The ID of the order to cancel
      body:
        type: json
        data: '{}'
    docs: Cancels an order.
- info:
    name: Inventory
    type: folder
  items:
  - info:
      name: List Inventory Items
      type: http
    http:
      method: GET
      url: https://{store_name}.myshopify.com/admin/api/2024-10/inventory_items.json
      params:
      - name: ids
        value: ''
        type: query
        description: Show only inventory items specified by a comma-separated list of IDs
      - name: limit
        value: ''
        type: query
        description: The maximum number of results to show
    docs: Retrieves a list of inventory items.
  - info:
      name: List Inventory Levels
      type: http
    http:
      method: GET
      url: https://{store_name}.myshopify.com/admin/api/2024-10/inventory_levels.json
      params:
      - name: inventory_item_ids
        value: ''
        type: query
        description: Comma-separated list of inventory item IDs
      - name: location_ids
        value: ''
        type: query
        description: Comma-separated list of location IDs
    docs: Retrieves a list of inventory levels for specified inventory items or locations.
- info:
    name: Locations
    type: folder
  items:
  - info:
      name: List Locations
      type: http
    http:
      method: GET
      url: https://{store_name}.myshopify.com/admin/api/2024-10/locations.json
    docs: Retrieves a list of locations for the store.
- info:
    name: Webhooks
    type: folder
  items:
  - info:
      name: List Webhooks
      type: http
    http:
      method: GET
      url: https://{store_name}.myshopify.com/admin/api/2024-10/webhooks.json
    docs: Retrieves a list of webhook subscriptions.
  - info:
      name: Create Webhook
      type: http
    http:
      method: POST
      url: https://{store_name}.myshopify.com/admin/api/2024-10/webhooks.json
      body:
        type: json
        data: '{}'
    docs: Creates a new webhook subscription.
  - info:
      name: Delete Webhook
      type: http
    http:
      method: DELETE
      url: https://{store_name}.myshopify.com/admin/api/2024-10/webhooks/:webhook_id.json
      params:
      - name: webhook_id
        value: ''
        type: path
        description: The ID of the webhook
    docs: Deletes a webhook subscription.
- info:
    name: Shop
    type: folder
  items:
  - info:
      name: Get Shop
      type: http
    http:
      method: GET
      url: https://{store_name}.myshopify.com/admin/api/2024-10/shop.json
    docs: Retrieves configuration and settings for the store.
- info:
    name: Collections
    type: folder
  items:
  - info:
      name: List Collects
      type: http
    http:
      method: GET
      url: https://{store_name}.myshopify.com/admin/api/2024-10/collects.json
      params:
      - name: collection_id
        value: ''
        type: query
        description: Filter by collection ID
      - name: product_id
        value: ''
        type: query
        description: Filter by product ID
    docs: Retrieves a list of collects (product-collection relationships).
  - info:
      name: List Custom Collections
      type: http
    http:
      method: GET
      url: https://{store_name}.myshopify.com/admin/api/2024-10/custom_collections.json
      params:
      - name: limit
        value: ''
        type: query
        description: The maximum number of results to show
    docs: Retrieves a list of custom collections.
bundled: true