openapi: 3.1.0
info:
  title: Shopify Admin REST About Information 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: Information
paths:
  /admin/api/2020-01/users/current.json:
    get:
      summary: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2020-01
      parameters: []
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_users_current
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/users/current.json:
    get:
      summary: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2020-04
      parameters: []
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_users_current
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/users/current.json:
    get:
      summary: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2020-07
      parameters: []
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_users_current
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/users/current.json:
    get:
      summary: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2020-10
      parameters: []
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: get_users_current
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/users/current.json:
    get:
      summary: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2021-01
      parameters: []
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_users_current
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/users/current.json:
    get:
      summary: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-unstable
      parameters: []
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_users_current
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/checkouts/{token}/payments/{payment_id}.json:
    get:
      summary: Shopify Retrieves The Payment Information For An Existing Payment
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2020-01
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      - in: path
        name: payment_id
        required: true
        schema:
          type: string
        description: payment_id
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_checkouts_param_token_payments_param_payment_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/checkouts/{token}/payments/{payment_id}.json:
    get:
      summary: Shopify Retrieves The Payment Information For An Existing Payment
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2020-04
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      - in: path
        name: payment_id
        required: true
        schema:
          type: string
        description: payment_id
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_checkouts_param_token_payments_param_payment_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/checkouts/{token}/payments/{payment_id}.json:
    get:
      summary: Shopify Retrieves The Payment Information For An Existing Payment
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2020-07
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      - in: path
        name: payment_id
        required: true
        schema:
          type: string
        description: payment_id
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_checkouts_param_token_payments_param_payment_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/checkouts/{token}/payments/{payment_id}.json:
    get:
      summary: Shopify Retrieves The Payment Information For An Existing Payment
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2020-10
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      - in: path
        name: payment_id
        required: true
        schema:
          type: string
        description: payment_id
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: get_checkouts_param_token_payments_param_payment_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/checkouts/{token}/payments/{payment_id}.json:
    get:
      summary: Shopify Retrieves The Payment Information For An Existing Payment
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2021-01
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      - in: path
        name: payment_id
        required: true
        schema:
          type: string
        description: payment_id
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_checkouts_param_token_payments_param_payment_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/checkouts/{token}/payments/{payment_id}.json:
    get:
      summary: Shopify Retrieves The Payment Information For An Existing Payment
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-unstable
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      - in: path
        name: payment_id
        required: true
        schema:
          type: string
        description: payment_id
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_checkouts_param_token_payments_param_payment_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment:
                    tracking_number: '987654321'
                    id: 255858046
                summary: Update the tracking number for a fulfillment
      summary: Shopify Update Information Associated With A Fulfillment
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-2020-01
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: fulfillment_id
        required: true
        schema:
          type: string
        description: fulfillment_id
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_orders_param_order_id_fulfillments_param_fulfillment_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/fulfillments/{fulfillment_id}/update_tracking.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment:
                    notify_customer: true
                    tracking_info:
                      number: '1111'
                      url: http://www.my-url.com
                      company: my-company
                summary: Update the tracking information for a fulfillment
      summary: Shopify Updates The Tracking Information For A Fulfillment
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update_tracking-2020-01
      parameters:
      - in: path
        name: fulfillment_id
        required: true
        schema:
          type: string
        description: fulfillment_id
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_fulfillments_param_fulfillment_id_update_tracking
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment:
                    tracking_number: '987654321'
                    id: 255858046
                summary: Update the tracking number for a fulfillment
      summary: Shopify Update Information Associated With A Fulfillment
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-2020-04
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: fulfillment_id
        required: true
        schema:
          type: string
        description: fulfillment_id
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_orders_param_order_id_fulfillments_param_fulfillment_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/fulfillments/{fulfillment_id}/update_tracking.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment:
                    notify_customer: true
                    tracking_info:
                      number: '1111'
                      url: http://www.my-url.com
                      company: my-company
                summary: Update the tracking information for a fulfillment
      summary: Shopify Updates The Tracking Information For A Fulfillment
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update_tracking-2020-04
      parameters:
      - in: path
        name: fulfillment_id
        required: true
        schema:
          type: string
        description: fulfillment_id
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_fulfillments_param_fulfillment_id_update_tracking
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment:
                    tracking_number: '987654321'
                    id: 255858046
                summary: Update the tracking number for a fulfillment
      summary: Shopify Update Information Associated With A Fulfillment
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-2020-07
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: fulfillment_id
        required: true
        schema:
          type: string
        description: fulfillment_id
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_orders_param_order_id_fulfillments_param_fulfillment_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/fulfillments/{fulfillment_id}/update_tracking.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment:
                    notify_customer: true
                    tracking_info:
                      number: '1111'
                      url: http://www.my-url.com
                      company: my-company
                summary: Update the tracking information for a fulfillment
      summary: Shopify Updates The Tracking Information For A Fulfillment
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update_tracking-2020-07
      parameters:
      - in: path
        name: fulfillment_id
        required: true
        schema:
          type: string
        description: fulfillment_id
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_fulfillments_param_fulfillment_id_update_tracking
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment:
                    tracking_number: '987654321'
                    id: 255858046
                summary: Update the tracking number for a fulfillment
      summary: Shopify Update Information Associated With A Fulfillment
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-2020-10
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: fulfillment_id
        required: true
        schema:
          type: string
        description: fulfillment_id
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: update_orders_param_order_id_fulfillments_param_fulfillment_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/fulfillments/{fulfillment_id}/update_tracking.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment:
                    notify_customer: true
                    tracking_info:
                      number: '1111'
                      url: http://www.my-url.com
                      company: my-company
                summary: Update the tracking information for a fulfillment
      summary: Shopify Updates The Tracking Information For A Fulfillment
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update_tracking-2020-10
      parameters:
      - in: path
        name: fulfillment_id
        required: true
        schema:
          type: string
        description: fulfillment_id
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: create_fulfillments_param_fulfillment_id_update_tracking
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment:
                    tracking_number: '987654321'
                    id: 255858046
                summary: Update the tracking number for a fulfillment
      summary: Shopify Update Information Associated With A Fulfillment
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-2021-01
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: fulfillment_id
        required: true
        schema:
          type: string
        description: fulfillment_id
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_update_orders_param_order_id_fulfillments_param_fulfillment_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/fulfillments/{fulfillment_id}/update_tracking.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment:
                    notify_customer: true
                    tracking_info:
                      number: '1111'
                      url: http://www.my-url.com
                      company: my-company
                summary: Update the tracking information for a fulfillment
      summary: Shopify Updates The Tracking Information For A Fulfillment
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update_tracking-2021-01
      parameters:
      - in: path
        name: fulfillment_id
        required: true
        schema:
          type: string
        description: fulfillment_id
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_fulfillments_param_fulfillment_id_update_tracking
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}.json:
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment:
                    tracking_number: '987654321'
                    id: 255858046
                summary: Update the tracking number for a fulfillment
      summary: Shopify Update Information Associated With A Fulfillment
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-unstable
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: fulfillment_id
        required: true
        schema:
          type: string
        description: fulfillment_id
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_update_orders_param_order_id_fulfillments_param_fulfillment_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/fulfillments/{fulfillment_id}/update_tracking.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  fulfillment:
                    notify_customer: true
                    tracking_info:
                      number: '1111'
                      url: http://www.my-url.com
                      company: my-company
                summary: Update the tracking information for a fulfillment
      summary: Shopify Updates The Tracking Information For A Fulfillment
      description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update_tracking-unstable
      parameters:
      - in: path
        name: fulfillment_id
        required: true
        schema:
          type: string
        description: fulfillment_id
      tags:
      - Information
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_fulfillments_param_fulfillment_id_update_tracking
      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