openapi: 3.1.0
info:
  title: Shopify Admin REST About Checkout 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: Checkout
paths:
  /admin/api/2020-01/checkouts.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  checkout:
                    line_items:
                    - variant_id: 39072856
                      quantity: 5
                summary: Create a checkout with a product variant and quantity
              example2:
                value:
                  checkout:
                    line_items:
                    - variant_id: 123456789
                      quantity: 1
                summary: Creating a checkout with errors, such as using the ID of a variant that doesn't exist or that isn't published to your sales channel, fails with a 422 response and returns errors
              example3:
                value:
                  checkout:
                    line_items:
                    - variant_id: 39072856
                      quantity: 1
                    - variant_id: 1
                      quantity: 1
                    - variant_id: 1
                      quantity: 1
                    - variant_id: 49148385
                      quantity: 1
                    - variant_id: 1
                      quantity: 1
                summary: Creating a checkout with line item errors fails and returns the errors mapped by index
              example4:
                value:
                  checkout:
                    email: me@example.com
                summary: Create a checkout without any line items
      summary: Shopify Creates A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#create-2020-01
      parameters: []
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_checkouts
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/checkouts.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  checkout:
                    line_items:
                    - variant_id: 39072856
                      quantity: 5
                summary: Create a checkout with a product variant and quantity
              example2:
                value:
                  checkout:
                    line_items:
                    - variant_id: 123456789
                      quantity: 1
                summary: Creating a checkout with errors, such as using the ID of a variant that doesn't exist or that isn't published to your sales channel, fails with a 422 response and returns errors
              example3:
                value:
                  checkout:
                    line_items:
                    - variant_id: 39072856
                      quantity: 1
                    - variant_id: 1
                      quantity: 1
                    - variant_id: 1
                      quantity: 1
                    - variant_id: 49148385
                      quantity: 1
                    - variant_id: 1
                      quantity: 1
                summary: Creating a checkout with line item errors fails and returns the errors mapped by index
              example4:
                value:
                  checkout:
                    email: me@example.com
                summary: Create a checkout without any line items
      summary: Shopify Creates A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#create-2020-04
      parameters: []
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_checkouts
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/checkouts.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  checkout:
                    line_items:
                    - variant_id: 39072856
                      quantity: 5
                summary: Create a checkout with a product variant and quantity
              example2:
                value:
                  checkout:
                    line_items:
                    - variant_id: 123456789
                      quantity: 1
                summary: Creating a checkout with errors, such as using the ID of a variant that doesn't exist or that isn't published to your sales channel, fails with a 422 response and returns errors
              example3:
                value:
                  checkout:
                    line_items:
                    - variant_id: 39072856
                      quantity: 1
                    - variant_id: 1
                      quantity: 1
                    - variant_id: 1
                      quantity: 1
                    - variant_id: 49148385
                      quantity: 1
                    - variant_id: 1
                      quantity: 1
                summary: Creating a checkout with line item errors fails and returns the errors mapped by index
              example4:
                value:
                  checkout:
                    email: me@example.com
                summary: Create a checkout without any line items
      summary: Shopify Creates A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#create-2020-07
      parameters: []
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_checkouts
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/checkouts.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  checkout:
                    line_items:
                    - variant_id: 39072856
                      quantity: 5
                summary: Create a checkout with a product variant and quantity
              example2:
                value:
                  checkout:
                    line_items:
                    - variant_id: 123456789
                      quantity: 1
                summary: Creating a checkout with errors, such as using the ID of a variant that doesn't exist or that isn't published to your sales channel, fails with a 422 response and returns errors
              example3:
                value:
                  checkout:
                    line_items:
                    - variant_id: 39072856
                      quantity: 1
                    - variant_id: 1
                      quantity: 1
                    - variant_id: 1
                      quantity: 1
                    - variant_id: 49148385
                      quantity: 1
                    - variant_id: 1
                      quantity: 1
                summary: Creating a checkout with line item errors fails and returns the errors mapped by index
              example4:
                value:
                  checkout:
                    email: me@example.com
                summary: Create a checkout without any line items
      summary: Shopify Creates A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#create-2020-10
      parameters: []
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: create_checkouts
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/checkouts.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  checkout:
                    line_items:
                    - variant_id: 39072856
                      quantity: 5
                summary: Create a checkout with a product variant and quantity
              example2:
                value:
                  checkout:
                    line_items:
                    - variant_id: 123456789
                      quantity: 1
                summary: Creating a checkout with errors, such as using the ID of a variant that doesn't exist or that isn't published to your sales channel, fails with a 422 response and returns errors
              example3:
                value:
                  checkout:
                    line_items:
                    - variant_id: 39072856
                      quantity: 1
                    - variant_id: 1
                      quantity: 1
                    - variant_id: 1
                      quantity: 1
                    - variant_id: 49148385
                      quantity: 1
                    - variant_id: 1
                      quantity: 1
                summary: Creating a checkout with line item errors fails and returns the errors mapped by index
              example4:
                value:
                  checkout:
                    email: me@example.com
                summary: Create a checkout without any line items
      summary: Shopify Creates A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#create-2021-01
      parameters: []
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_checkouts
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/checkouts.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  checkout:
                    line_items:
                    - variant_id: 39072856
                      quantity: 5
                summary: Create a checkout with a product variant and quantity
              example2:
                value:
                  checkout:
                    line_items:
                    - variant_id: 123456789
                      quantity: 1
                summary: Creating a checkout with errors, such as using the ID of a variant that doesn't exist or that isn't published to your sales channel, fails with a 422 response and returns errors
              example3:
                value:
                  checkout:
                    line_items:
                    - variant_id: 39072856
                      quantity: 1
                    - variant_id: 1
                      quantity: 1
                    - variant_id: 1
                      quantity: 1
                    - variant_id: 49148385
                      quantity: 1
                    - variant_id: 1
                      quantity: 1
                summary: Creating a checkout with line item errors fails and returns the errors mapped by index
              example4:
                value:
                  checkout:
                    email: me@example.com
                summary: Create a checkout without any line items
      summary: Shopify Creates A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#create-unstable
      parameters: []
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_checkouts
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/checkouts/{token}/complete.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value: {}
                summary: Complete a checkout without requiring payment
      summary: Shopify Completes A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#complete-2020-01
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_checkouts_param_token_complete
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/checkouts/{token}.json:
    get:
      summary: Shopify Retrieves A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-2020-01
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_checkouts_param_token
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  checkout:
                    token: exuw7apwoycchjuwtiqg8nytfhphr62a
                    email: john.smith@example.com
                    shipping_address:
                      first_name: John
                      last_name: Smith
                      address1: 126 York St.
                      city: Los Angeles
                      province_code: CA
                      country_code: US
                      phone: (123)456-7890
                      zip: '90002'
                summary: Update the shipping address and email of a checkout
              example2:
                value:
                  checkout:
                    token: exuw7apwoycchjuwtiqg8nytfhphr62a
                    shipping_line:
                      handle: shopify-Free%20Shipping-0.00
                summary: Select a shipping rate
              example3:
                value:
                  checkout:
                    token: exuw7apwoycchjuwtiqg8nytfhphr62a
                    shipping_address:
                      first_name: John
                      last_name: Smith
                      address1: 126 York St.
                      city: Beverly Hills
                      province_code: CA
                      country_code: US
                      phone: (123)456-7890
                      zip: '1234'
                summary: Updating a shipping address with an invalid zip code fails and returns errors
      summary: Shopify Modifies An Existing Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#update-2020-01
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_checkouts_param_token
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/checkouts/{token}/shipping_rates.json:
    get:
      summary: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2020-01
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_checkouts_param_token_shipping_rates
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/checkouts/{token}/complete.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value: {}
                summary: Complete a checkout without requiring payment
      summary: Shopify Completes A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#complete-2020-04
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_checkouts_param_token_complete
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/checkouts/{token}.json:
    get:
      summary: Shopify Retrieves A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-2020-04
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_checkouts_param_token
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  checkout:
                    token: exuw7apwoycchjuwtiqg8nytfhphr62a
                    email: john.smith@example.com
                    shipping_address:
                      first_name: John
                      last_name: Smith
                      address1: 126 York St.
                      city: Los Angeles
                      province_code: CA
                      country_code: US
                      phone: (123)456-7890
                      zip: '90002'
                summary: Update the shipping address and email of a checkout
              example2:
                value:
                  checkout:
                    token: exuw7apwoycchjuwtiqg8nytfhphr62a
                    shipping_line:
                      handle: shopify-Free%20Shipping-0.00
                summary: Select a shipping rate
              example3:
                value:
                  checkout:
                    token: exuw7apwoycchjuwtiqg8nytfhphr62a
                    shipping_address:
                      first_name: John
                      last_name: Smith
                      address1: 126 York St.
                      city: Beverly Hills
                      province_code: CA
                      country_code: US
                      phone: (123)456-7890
                      zip: '1234'
                summary: Updating a shipping address with an invalid zip code fails and returns errors
      summary: Shopify Modifies An Existing Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#update-2020-04
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_checkouts_param_token
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/checkouts/{token}/shipping_rates.json:
    get:
      summary: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2020-04
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_checkouts_param_token_shipping_rates
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/checkouts/{token}/complete.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value: {}
                summary: Complete a checkout without requiring payment
      summary: Shopify Completes A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#complete-2020-07
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_checkouts_param_token_complete
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/checkouts/{token}.json:
    get:
      summary: Shopify Retrieves A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-2020-07
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_checkouts_param_token
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  checkout:
                    token: exuw7apwoycchjuwtiqg8nytfhphr62a
                    email: john.smith@example.com
                    shipping_address:
                      first_name: John
                      last_name: Smith
                      address1: 126 York St.
                      city: Los Angeles
                      province_code: CA
                      country_code: US
                      phone: (123)456-7890
                      zip: '90002'
                summary: Update the shipping address and email of a checkout
              example2:
                value:
                  checkout:
                    token: exuw7apwoycchjuwtiqg8nytfhphr62a
                    shipping_line:
                      handle: shopify-Free%20Shipping-0.00
                summary: Select a shipping rate
              example3:
                value:
                  checkout:
                    token: exuw7apwoycchjuwtiqg8nytfhphr62a
                    shipping_address:
                      first_name: John
                      last_name: Smith
                      address1: 126 York St.
                      city: Beverly Hills
                      province_code: CA
                      country_code: US
                      phone: (123)456-7890
                      zip: '1234'
                summary: Updating a shipping address with an invalid zip code fails and returns errors
      summary: Shopify Modifies An Existing Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#update-2020-07
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_checkouts_param_token
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/checkouts/{token}/shipping_rates.json:
    get:
      summary: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2020-07
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_checkouts_param_token_shipping_rates
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/checkouts/{token}/complete.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value: {}
                summary: Complete a checkout without requiring payment
      summary: Shopify Completes A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#complete-2020-10
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: create_checkouts_param_token_complete
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/checkouts/{token}.json:
    get:
      summary: Shopify Retrieves A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-2020-10
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: get_checkouts_param_token
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  checkout:
                    token: exuw7apwoycchjuwtiqg8nytfhphr62a
                    email: john.smith@example.com
                    shipping_address:
                      first_name: John
                      last_name: Smith
                      address1: 126 York St.
                      city: Los Angeles
                      province_code: CA
                      country_code: US
                      phone: (123)456-7890
                      zip: '90002'
                summary: Update the shipping address and email of a checkout
              example2:
                value:
                  checkout:
                    token: exuw7apwoycchjuwtiqg8nytfhphr62a
                    shipping_line:
                      handle: shopify-Free%20Shipping-0.00
                summary: Select a shipping rate
              example3:
                value:
                  checkout:
                    token: exuw7apwoycchjuwtiqg8nytfhphr62a
                    shipping_address:
                      first_name: John
                      last_name: Smith
                      address1: 126 York St.
                      city: Beverly Hills
                      province_code: CA
                      country_code: US
                      phone: (123)456-7890
                      zip: '1234'
                summary: Updating a shipping address with an invalid zip code fails and returns errors
      summary: Shopify Modifies An Existing Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#update-2020-10
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: update_checkouts_param_token
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/checkouts/{token}/shipping_rates.json:
    get:
      summary: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2020-10
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: get_checkouts_param_token_shipping_rates
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/checkouts/{token}/complete.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value: {}
                summary: Complete a checkout without requiring payment
      summary: Shopify Completes A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#complete-2021-01
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_checkouts_param_token_complete
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/checkouts/{token}.json:
    get:
      summary: Shopify Retrieves A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-2021-01
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_checkouts_param_token
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  checkout:
                    token: exuw7apwoycchjuwtiqg8nytfhphr62a
                    email: john.smith@example.com
                    shipping_address:
                      first_name: John
                      last_name: Smith
                      address1: 126 York St.
                      city: Los Angeles
                      province_code: CA
                      country_code: US
                      phone: (123)456-7890
                      zip: '90002'
                summary: Update the shipping address and email of a checkout
              example2:
                value:
                  checkout:
                    token: exuw7apwoycchjuwtiqg8nytfhphr62a
                    shipping_line:
                      handle: shopify-Free%20Shipping-0.00
                summary: Select a shipping rate
              example3:
                value:
                  checkout:
                    token: exuw7apwoycchjuwtiqg8nytfhphr62a
                    shipping_address:
                      first_name: John
                      last_name: Smith
                      address1: 126 York St.
                      city: Beverly Hills
                      province_code: CA
                      country_code: US
                      phone: (123)456-7890
                      zip: '1234'
                summary: Updating a shipping address with an invalid zip code fails and returns errors
      summary: Shopify Modifies An Existing Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#update-2021-01
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_update_checkouts_param_token
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/checkouts/{token}/shipping_rates.json:
    get:
      summary: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2021-01
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_checkouts_param_token_shipping_rates
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/checkouts/{token}/complete.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value: {}
                summary: Complete a checkout without requiring payment
      summary: Shopify Completes A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#complete-unstable
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_checkouts_param_token_complete
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/checkouts/{token}.json:
    get:
      summary: Shopify Retrieves A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-unstable
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_checkouts_param_token
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  checkout:
                    token: exuw7apwoycchjuwtiqg8nytfhphr62a
                    email: john.smith@example.com
                    shipping_address:
                      first_name: John
                      last_name: Smith
                      address1: 126 York St.
                      city: Los Angeles
                      province_code: CA
                      country_code: US
                      phone: (123)456-7890
                      zip: '90002'
                summary: Update the shipping address and email of a checkout
              example2:
                value:
                  checkout:
                    token: exuw7apwoycchjuwtiqg8nytfhphr62a
                    shipping_line:
                      handle: shopify-Free%20Shipping-0.00
                summary: Select a shipping rate
              example3:
                value:
                  checkout:
                    token: exuw7apwoycchjuwtiqg8nytfhphr62a
                    shipping_address:
                      first_name: John
                      last_name: Smith
                      address1: 126 York St.
                      city: Beverly Hills
                      province_code: CA
                      country_code: US
                      phone: (123)456-7890
                      zip: '1234'
                summary: Updating a shipping address with an invalid zip code fails and returns errors
      summary: Shopify Modifies An Existing Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#update-unstable
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_update_checkouts_param_token
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/checkouts/{token}/shipping_rates.json:
    get:
      summary: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-unstable
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_checkouts_param_token_shipping_rates
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/checkouts/{token}/payments.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '398.00'
                    session_id: global-2b883b5dbab7059e
                    unique_token: client-side-idempotency-token
                summary: Create an authorization using a valid session_id stored in the vault
              example2:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '419.49'
                    session_id: global-a61a334b946b55fb
                    unique_token: client-side-idempotency-token
                summary: Creating an authorization with a valid session ID but an invalid credit card number fails and returns errors
              example3:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '419.49'
                    session_id: global-an_invalid_session_id
                    unique_token: client-side-idempotency-token
                summary: Creating an authorization with an invalid session ID fails and returns errors
              example4:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '398.00'
                    session_id: global-d0436243a47a3418
                    unique_token: client-side-idempotency-token
                summary: Creating an authorization with a valid session can fail for various reasons
      summary: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-01
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      - in: query
        name: "amount\n                  required"
        description: The amount of the payment.
        schema: {}
        required: false
      - in: query
        name: "request_details\n                  required"
        description: "The details of the request, including the following attributes:\n                    \n                        ip_address: The IP address of the customer.\n                        accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n                        user_agent: The user agent string for the customer's device."
        schema: {}
        required: false
      - in: query
        name: "session_id\n                  required"
        description: A session ID provided by the card vault when creating a payment session.
        schema: {}
        required: false
      - in: query
        name: "unique_token\n                  required"
        description: A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests.
        schema: {}
        required: false
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_checkouts_param_token_payments
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves A List Of Payments On A Particular Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2020-01
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_checkouts_param_token_payments
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/checkouts/{token}/payments/count.json:
    get:
      summary: Shopify Counts The Number Of Payments Attempted On A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-2020-01
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_checkouts_param_token_payments_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/checkouts/{token}/payments.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '398.00'
                    session_id: global-2b883b5dbab7059e
                    unique_token: client-side-idempotency-token
                summary: Create an authorization using a valid session_id stored in the vault
              example2:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '419.49'
                    session_id: global-a61a334b946b55fb
                    unique_token: client-side-idempotency-token
                summary: Creating an authorization with a valid session ID but an invalid credit card number fails and returns errors
              example3:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '419.49'
                    session_id: global-an_invalid_session_id
                    unique_token: client-side-idempotency-token
                summary: Creating an authorization with an invalid session ID fails and returns errors
              example4:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '398.00'
                    session_id: global-d0436243a47a3418
                    unique_token: client-side-idempotency-token
                summary: Creating an authorization with a valid session can fail for various reasons
      summary: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-04
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      - in: query
        name: "amount\n                  required"
        description: The amount of the payment.
        schema: {}
        required: false
      - in: query
        name: "request_details\n                  required"
        description: "The details of the request, including the following attributes:\n                    \n                        ip_address: The IP address of the customer.\n                        accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n                        user_agent: The user agent string for the customer's device."
        schema: {}
        required: false
      - in: query
        name: "session_id\n                  required"
        description: A session ID provided by the card vault when creating a payment session.
        schema: {}
        required: false
      - in: query
        name: "unique_token\n                  required"
        description: A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests.
        schema: {}
        required: false
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_checkouts_param_token_payments
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves A List Of Payments On A Particular Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2020-04
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_checkouts_param_token_payments
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/checkouts/{token}/payments/count.json:
    get:
      summary: Shopify Counts The Number Of Payments Attempted On A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-2020-04
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_checkouts_param_token_payments_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/checkouts/{token}/payments.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '398.00'
                    session_id: global-2b883b5dbab7059e
                    unique_token: client-side-idempotency-token
                summary: Create an authorization using a valid session_id stored in the vault
              example2:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '419.49'
                    session_id: global-a61a334b946b55fb
                    unique_token: client-side-idempotency-token
                summary: Creating an authorization with a valid session ID but an invalid credit card number fails and returns errors
              example3:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '419.49'
                    session_id: global-an_invalid_session_id
                    unique_token: client-side-idempotency-token
                summary: Creating an authorization with an invalid session ID fails and returns errors
              example4:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '398.00'
                    session_id: global-d0436243a47a3418
                    unique_token: client-side-idempotency-token
                summary: Creating an authorization with a valid session can fail for various reasons
      summary: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-07
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      - in: query
        name: "amount\n                  required"
        description: The amount of the payment.
        schema: {}
        required: false
      - in: query
        name: "request_details\n                  required"
        description: "The details of the request, including the following attributes:\n                    \n                        ip_address: The IP address of the customer.\n                        accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n                        user_agent: The user agent string for the customer's device."
        schema: {}
        required: false
      - in: query
        name: "session_id\n                  required"
        description: A session ID provided by the card vault when creating a payment session.
        schema: {}
        required: false
      - in: query
        name: "unique_token\n                  required"
        description: A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests.
        schema: {}
        required: false
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_checkouts_param_token_payments
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves A List Of Payments On A Particular Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2020-07
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_checkouts_param_token_payments
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/checkouts/{token}/payments/count.json:
    get:
      summary: Shopify Counts The Number Of Payments Attempted On A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-2020-07
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_checkouts_param_token_payments_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/checkouts/{token}/payments.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '398.00'
                    session_id: global-2b883b5dbab7059e
                    unique_token: client-side-idempotency-token
                summary: Create an authorization using a valid session_id stored in the vault
              example2:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '419.49'
                    session_id: global-a61a334b946b55fb
                    unique_token: client-side-idempotency-token
                summary: Creating an authorization with a valid session ID but an invalid credit card number fails and returns errors
              example3:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '419.49'
                    session_id: global-an_invalid_session_id
                    unique_token: client-side-idempotency-token
                summary: Creating an authorization with an invalid session ID fails and returns errors
              example4:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '398.00'
                    session_id: global-d0436243a47a3418
                    unique_token: client-side-idempotency-token
                summary: Creating an authorization with a valid session can fail for various reasons
      summary: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-10
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      - in: query
        name: "amount\n                  required"
        description: The amount of the payment.
        schema: {}
        required: false
      - in: query
        name: "request_details\n                  required"
        description: "The details of the request, including the following attributes:\n                    \n                        ip_address: The IP address of the customer.\n                        accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n                        user_agent: The user agent string for the customer's device."
        schema: {}
        required: false
      - in: query
        name: "session_id\n                  required"
        description: A session ID provided by the card vault when creating a payment session.
        schema: {}
        required: false
      - in: query
        name: "unique_token\n                  required"
        description: A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests.
        schema: {}
        required: false
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: create_checkouts_param_token_payments
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves A List Of Payments On A Particular Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2020-10
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: get_checkouts_param_token_payments
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/checkouts/{token}/payments/count.json:
    get:
      summary: Shopify Counts The Number Of Payments Attempted On A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-2020-10
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: get_checkouts_param_token_payments_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/checkouts/{token}/payments.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '398.00'
                    session_id: global-2b883b5dbab7059e
                    unique_token: client-side-idempotency-token
                summary: Create an authorization using a valid session_id stored in the vault
              example2:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '419.49'
                    session_id: global-a61a334b946b55fb
                    unique_token: client-side-idempotency-token
                summary: Creating an authorization with a valid session ID but an invalid credit card number fails and returns errors
              example3:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '419.49'
                    session_id: global-an_invalid_session_id
                    unique_token: client-side-idempotency-token
                summary: Creating an authorization with an invalid session ID fails and returns errors
              example4:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '398.00'
                    session_id: global-d0436243a47a3418
                    unique_token: client-side-idempotency-token
                summary: Creating an authorization with a valid session can fail for various reasons
      summary: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2021-01
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      - in: query
        name: "amount\n                  required"
        description: The amount of the payment.
        schema: {}
        required: false
      - in: query
        name: "request_details\n                  required"
        description: "The details of the request, including the following attributes:\n                    \n                        ip_address: The IP address of the customer.\n                        accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n                        user_agent: The user agent string for the customer's device."
        schema: {}
        required: false
      - in: query
        name: "session_id\n                  required"
        description: A session ID provided by the card vault when creating a payment session.
        schema: {}
        required: false
      - in: query
        name: "unique_token\n                  required"
        description: A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests.
        schema: {}
        required: false
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_checkouts_param_token_payments
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves A List Of Payments On A Particular Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2021-01
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_checkouts_param_token_payments
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/checkouts/{token}/payments/count.json:
    get:
      summary: Shopify Counts The Number Of Payments Attempted On A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-2021-01
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_checkouts_param_token_payments_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/checkouts/{token}/payments.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '398.00'
                    session_id: global-2b883b5dbab7059e
                    unique_token: client-side-idempotency-token
                summary: Create an authorization using a valid session_id stored in the vault
              example2:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '419.49'
                    session_id: global-a61a334b946b55fb
                    unique_token: client-side-idempotency-token
                summary: Creating an authorization with a valid session ID but an invalid credit card number fails and returns errors
              example3:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '419.49'
                    session_id: global-an_invalid_session_id
                    unique_token: client-side-idempotency-token
                summary: Creating an authorization with an invalid session ID fails and returns errors
              example4:
                value:
                  payment:
                    request_details:
                      ip_address: 123.1.1.1
                      accept_language: en-US,en;q=0.8,fr;q=0.6
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36
                    amount: '398.00'
                    session_id: global-d0436243a47a3418
                    unique_token: client-side-idempotency-token
                summary: Creating an authorization with a valid session can fail for various reasons
      summary: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-unstable
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      - in: query
        name: "amount\n                  required"
        description: The amount of the payment.
        schema: {}
        required: false
      - in: query
        name: "request_details\n                  required"
        description: "The details of the request, including the following attributes:\n                    \n                        ip_address: The IP address of the customer.\n                        accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n                        user_agent: The user agent string for the customer's device."
        schema: {}
        required: false
      - in: query
        name: "session_id\n                  required"
        description: A session ID provided by the card vault when creating a payment session.
        schema: {}
        required: false
      - in: query
        name: "unique_token\n                  required"
        description: A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests.
        schema: {}
        required: false
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_checkouts_param_token_payments
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    get:
      summary: Shopify Retrieves A List Of Payments On A Particular Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-unstable
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_checkouts_param_token_payments
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/checkouts/{token}/payments/count.json:
    get:
      summary: Shopify Counts The Number Of Payments Attempted On A Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-unstable
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Checkout
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_checkouts_param_token_payments_count
      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