Shopify

Shopify Rules API

The Rules API from Shopify — 6 operation(s) for rules.

GitHub OpenAPI

Documentation

📖
Documentation
https://shopify.dev/docs/api/admin-rest
📖
Documentation
https://shopify.dev/docs/api/ajax

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/openapi/shopify-rules-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-product-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-customer-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-order-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-collection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-inventory-item-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-fulfillment-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-structure/shopify-product-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-structure/shopify-order-structure.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-ld/shopify-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/examples/shopify-create-product-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/examples/shopify-list-orders-example.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/vocabulary/shopify-vocabulary.yml
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/rules/shopify-rules.yml
🔗
Reference
https://shopify.dev/docs/api/ajax/reference

OpenAPI Specification

shopify-rules-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Shopify Admin REST About Rules API
  description: The Shopify Admin REST API lets you build apps and integrations that extend and enhance the Shopify admin. Access products, customers, orders, inventory, fulfillment, and more. Endpoints are organized by resource type and versioned by release date.
  version: 2025-01
  contact:
    name: Shopify
    url: https://shopify.dev/docs/api/admin-rest
    email: api@shopify.com
  license:
    name: Shopify API Terms
    url: https://www.shopify.com/legal/api-terms
  x-date: '2026-03-04'
servers:
- url: https://{store}.myshopify.com/admin/api/2025-01
  description: Shopify Admin REST API
  variables:
    store:
      default: my-store
      description: The Shopify store subdomain
security:
- AccessToken: []
tags:
- name: Rules
paths:
  /admin/api/2020-01/smart_collections.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  smart_collection:
                    title: IPods
                    rules:
                    - column: title
                      relation: starts_with
                      condition: iPod
                summary: Create a smart collection of all products starting with the specified term
              example2:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                summary: Create a smart collection with a specified title
              example3:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                    published: false
                summary: Create a new unpublished smart collection
              example4:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                    image:
                      attachment: 'R0lGODlhAQABAIAAAAAAAAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==

                        '
                      alt: iPod
                summary: Create a new smart collection with a base64 encoded image
              example5:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                    image:
                      src: http://example.com/rails_logo.gif
                      alt: Rails Logo
                summary: Create a new smart collection with an image that will be downloaded by Shopify
              example6:
                value:
                  smart_collection:
                    body: foobar
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                summary: Creating a smart collection without a title will return an error
      summary: Shopify Creates A New Smart Collection Using The Specified Rules
      description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#create-2020-01
      parameters: []
      tags:
      - Rules
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_smart_collections
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/smart_collections.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  smart_collection:
                    title: IPods
                    rules:
                    - column: title
                      relation: starts_with
                      condition: iPod
                summary: Create a smart collection of all products starting with the specified term
              example2:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                summary: Create a smart collection with a specified title
              example3:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                    published: false
                summary: Create a new unpublished smart collection
              example4:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                    image:
                      attachment: 'R0lGODlhAQABAIAAAAAAAAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==

                        '
                      alt: iPod
                summary: Create a new smart collection with a base64 encoded image
              example5:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                    image:
                      src: http://example.com/rails_logo.gif
                      alt: Rails Logo
                summary: Create a new smart collection with an image that will be downloaded by Shopify
              example6:
                value:
                  smart_collection:
                    body: foobar
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                summary: Creating a smart collection without a title will return an error
      summary: Shopify Creates A New Smart Collection Using The Specified Rules
      description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#create-2020-04
      parameters: []
      tags:
      - Rules
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_smart_collections
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/smart_collections.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  smart_collection:
                    title: IPods
                    rules:
                    - column: title
                      relation: starts_with
                      condition: iPod
                summary: Create a smart collection of all products starting with the specified term
              example2:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                summary: Create a smart collection with a specified title
              example3:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                    published: false
                summary: Create a new unpublished smart collection
              example4:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                    image:
                      attachment: 'R0lGODlhAQABAIAAAAAAAAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==

                        '
                      alt: iPod
                summary: Create a new smart collection with a base64 encoded image
              example5:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                    image:
                      src: http://example.com/rails_logo.gif
                      alt: Rails Logo
                summary: Create a new smart collection with an image that will be downloaded by Shopify
              example6:
                value:
                  smart_collection:
                    body: foobar
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                summary: Creating a smart collection without a title will return an error
      summary: Shopify Creates A New Smart Collection Using The Specified Rules
      description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#create-2020-07
      parameters: []
      tags:
      - Rules
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_smart_collections
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/smart_collections.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  smart_collection:
                    title: IPods
                    rules:
                    - column: title
                      relation: starts_with
                      condition: iPod
                summary: Create a smart collection of all products starting with the specified term
              example2:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                summary: Create a smart collection with a specified title
              example3:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                    published: false
                summary: Create a new unpublished smart collection
              example4:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                    image:
                      attachment: 'R0lGODlhAQABAIAAAAAAAAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==

                        '
                      alt: iPod
                summary: Create a new smart collection with a base64 encoded image
              example5:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                    image:
                      src: http://example.com/rails_logo.gif
                      alt: Rails Logo
                summary: Create a new smart collection with an image that will be downloaded by Shopify
              example6:
                value:
                  smart_collection:
                    body: foobar
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                summary: Creating a smart collection without a title will return an error
      summary: Shopify Creates A New Smart Collection Using The Specified Rules
      description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#create-2020-10
      parameters: []
      tags:
      - Rules
      responses:
        '200':
          description: ''
      operationId: create_smart_collections
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/smart_collections.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  smart_collection:
                    title: IPods
                    rules:
                    - column: title
                      relation: starts_with
                      condition: iPod
                summary: Create a smart collection of all products starting with the specified term
              example2:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                summary: Create a smart collection with a specified title
              example3:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                    published: false
                summary: Create a new unpublished smart collection
              example4:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                    image:
                      attachment: 'R0lGODlhAQABAIAAAAAAAAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==

                        '
                      alt: iPod
                summary: Create a new smart collection with a base64 encoded image
              example5:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                    image:
                      src: http://example.com/rails_logo.gif
                      alt: Rails Logo
                summary: Create a new smart collection with an image that will be downloaded by Shopify
              example6:
                value:
                  smart_collection:
                    body: foobar
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                summary: Creating a smart collection without a title will return an error
      summary: Shopify Creates A New Smart Collection Using The Specified Rules
      description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#create-2021-01
      parameters: []
      tags:
      - Rules
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_smart_collections
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/smart_collections.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  smart_collection:
                    title: IPods
                    rules:
                    - column: title
                      relation: starts_with
                      condition: iPod
                summary: Create a smart collection of all products starting with the specified term
              example2:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                summary: Create a smart collection with a specified title
              example3:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                    published: false
                summary: Create a new unpublished smart collection
              example4:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                    image:
                      attachment: 'R0lGODlhAQABAIAAAAAAAAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==

                        '
                      alt: iPod
                summary: Create a new smart collection with a base64 encoded image
              example5:
                value:
                  smart_collection:
                    title: Macbooks
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                    image:
                      src: http://example.com/rails_logo.gif
                      alt: Rails Logo
                summary: Create a new smart collection with an image that will be downloaded by Shopify
              example6:
                value:
                  smart_collection:
                    body: foobar
                    rules:
                    - column: vendor
                      relation: equals
                      condition: Apple
                summary: Creating a smart collection without a title will return an error
      summary: Shopify Creates A New Smart Collection Using The Specified Rules
      description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#create-unstable
      parameters: []
      tags:
      - Rules
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_smart_collections
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
components:
  securitySchemes:
    AccessToken:
      type: apiKey
      name: X-Shopify-Access-Token
      in: header
      description: Access token obtained via OAuth