Shopify

Shopify Creation API

The Creation API from Shopify — 18 operation(s) for creation.

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-creation-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-creation-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Shopify Admin REST About Creation 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: Creation
paths:
  /admin/api/2020-01/price_rules/{price_rule_id}/batch.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  discount_codes:
                  - code: SUMMER1
                  - code: SUMMER2
                  - code: SUMMER3
                summary: Create a discount code creation job
      summary: Shopify Creates A Discount Code Creation Job
      description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_create-2020-01
      parameters:
      - in: path
        name: price_rule_id
        required: true
        schema:
          type: string
        description: price_rule_id
      tags:
      - Creation
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_price_rules_param_price_rule_id_batch
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/price_rules/{price_rule_id}/batch/{batch_id}.json:
    get:
      summary: Shopify Retrieves A Discount Code Creation Job
      description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_show-2020-01
      parameters:
      - in: path
        name: price_rule_id
        required: true
        schema:
          type: string
        description: price_rule_id
      - in: path
        name: batch_id
        required: true
        schema:
          type: string
        description: batch_id
      tags:
      - Creation
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_price_rules_param_price_rule_id_batch_param_batch_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json:
    get:
      summary: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job
      description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2020-01
      parameters:
      - in: path
        name: price_rule_id
        required: true
        schema:
          type: string
        description: price_rule_id
      - in: path
        name: batch_id
        required: true
        schema:
          type: string
        description: batch_id
      tags:
      - Creation
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_price_rules_param_price_rule_id_batch_param_batch_id_discount_codes
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/price_rules/{price_rule_id}/batch.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  discount_codes:
                  - code: SUMMER1
                  - code: SUMMER2
                  - code: SUMMER3
                summary: Create a discount code creation job
      summary: Shopify Creates A Discount Code Creation Job
      description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_create-2020-04
      parameters:
      - in: path
        name: price_rule_id
        required: true
        schema:
          type: string
        description: price_rule_id
      tags:
      - Creation
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_price_rules_param_price_rule_id_batch
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/price_rules/{price_rule_id}/batch/{batch_id}.json:
    get:
      summary: Shopify Retrieves A Discount Code Creation Job
      description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_show-2020-04
      parameters:
      - in: path
        name: price_rule_id
        required: true
        schema:
          type: string
        description: price_rule_id
      - in: path
        name: batch_id
        required: true
        schema:
          type: string
        description: batch_id
      tags:
      - Creation
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_price_rules_param_price_rule_id_batch_param_batch_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json:
    get:
      summary: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job
      description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2020-04
      parameters:
      - in: path
        name: price_rule_id
        required: true
        schema:
          type: string
        description: price_rule_id
      - in: path
        name: batch_id
        required: true
        schema:
          type: string
        description: batch_id
      tags:
      - Creation
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_price_rules_param_price_rule_id_batch_param_batch_id_discount_codes
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/price_rules/{price_rule_id}/batch.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  discount_codes:
                  - code: SUMMER1
                  - code: SUMMER2
                  - code: SUMMER3
                summary: Create a discount code creation job
      summary: Shopify Creates A Discount Code Creation Job
      description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_create-2020-07
      parameters:
      - in: path
        name: price_rule_id
        required: true
        schema:
          type: string
        description: price_rule_id
      tags:
      - Creation
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_price_rules_param_price_rule_id_batch
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/price_rules/{price_rule_id}/batch/{batch_id}.json:
    get:
      summary: Shopify Retrieves A Discount Code Creation Job
      description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_show-2020-07
      parameters:
      - in: path
        name: price_rule_id
        required: true
        schema:
          type: string
        description: price_rule_id
      - in: path
        name: batch_id
        required: true
        schema:
          type: string
        description: batch_id
      tags:
      - Creation
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_price_rules_param_price_rule_id_batch_param_batch_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json:
    get:
      summary: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job
      description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2020-07
      parameters:
      - in: path
        name: price_rule_id
        required: true
        schema:
          type: string
        description: price_rule_id
      - in: path
        name: batch_id
        required: true
        schema:
          type: string
        description: batch_id
      tags:
      - Creation
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_price_rules_param_price_rule_id_batch_param_batch_id_discount_codes
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/price_rules/{price_rule_id}/batch.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  discount_codes:
                  - code: SUMMER1
                  - code: SUMMER2
                  - code: SUMMER3
                summary: Create a discount code creation job
      summary: Shopify Creates A Discount Code Creation Job
      description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_create-2020-10
      parameters:
      - in: path
        name: price_rule_id
        required: true
        schema:
          type: string
        description: price_rule_id
      tags:
      - Creation
      responses:
        '200':
          description: ''
      operationId: create_price_rules_param_price_rule_id_batch
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/price_rules/{price_rule_id}/batch/{batch_id}.json:
    get:
      summary: Shopify Retrieves A Discount Code Creation Job
      description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_show-2020-10
      parameters:
      - in: path
        name: price_rule_id
        required: true
        schema:
          type: string
        description: price_rule_id
      - in: path
        name: batch_id
        required: true
        schema:
          type: string
        description: batch_id
      tags:
      - Creation
      responses:
        '200':
          description: ''
      operationId: get_price_rules_param_price_rule_id_batch_param_batch_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json:
    get:
      summary: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job
      description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2020-10
      parameters:
      - in: path
        name: price_rule_id
        required: true
        schema:
          type: string
        description: price_rule_id
      - in: path
        name: batch_id
        required: true
        schema:
          type: string
        description: batch_id
      tags:
      - Creation
      responses:
        '200':
          description: ''
      operationId: get_price_rules_param_price_rule_id_batch_param_batch_id_discount_codes
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/price_rules/{price_rule_id}/batch.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  discount_codes:
                  - code: SUMMER1
                  - code: SUMMER2
                  - code: SUMMER3
                summary: Create a discount code creation job
      summary: Shopify Creates A Discount Code Creation Job
      description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_create-2021-01
      parameters:
      - in: path
        name: price_rule_id
        required: true
        schema:
          type: string
        description: price_rule_id
      tags:
      - Creation
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_price_rules_param_price_rule_id_batch
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/price_rules/{price_rule_id}/batch/{batch_id}.json:
    get:
      summary: Shopify Retrieves A Discount Code Creation Job
      description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_show-2021-01
      parameters:
      - in: path
        name: price_rule_id
        required: true
        schema:
          type: string
        description: price_rule_id
      - in: path
        name: batch_id
        required: true
        schema:
          type: string
        description: batch_id
      tags:
      - Creation
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_price_rules_param_price_rule_id_batch_param_batch_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json:
    get:
      summary: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job
      description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2021-01
      parameters:
      - in: path
        name: price_rule_id
        required: true
        schema:
          type: string
        description: price_rule_id
      - in: path
        name: batch_id
        required: true
        schema:
          type: string
        description: batch_id
      tags:
      - Creation
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_price_rules_param_price_rule_id_batch_param_batch_id_discount_codes
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/price_rules/{price_rule_id}/batch.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  discount_codes:
                  - code: SUMMER1
                  - code: SUMMER2
                  - code: SUMMER3
                summary: Create a discount code creation job
      summary: Shopify Creates A Discount Code Creation Job
      description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_create-unstable
      parameters:
      - in: path
        name: price_rule_id
        required: true
        schema:
          type: string
        description: price_rule_id
      tags:
      - Creation
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_price_rules_param_price_rule_id_batch
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/price_rules/{price_rule_id}/batch/{batch_id}.json:
    get:
      summary: Shopify Retrieves A Discount Code Creation Job
      description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_show-unstable
      parameters:
      - in: path
        name: price_rule_id
        required: true
        schema:
          type: string
        description: price_rule_id
      - in: path
        name: batch_id
        required: true
        schema:
          type: string
        description: batch_id
      tags:
      - Creation
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_price_rules_param_price_rule_id_batch_param_batch_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json:
    get:
      summary: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job
      description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-unstable
      parameters:
      - in: path
        name: price_rule_id
        required: true
        schema:
          type: string
        description: price_rule_id
      - in: path
        name: batch_id
        required: true
        schema:
          type: string
        description: batch_id
      tags:
      - Creation
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_price_rules_param_price_rule_id_batch_param_batch_id_discount_codes
      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