Shopify

Shopify Refunds API

The Refunds API from Shopify — 6 operation(s) for refunds.

GitHub OpenAPI

Documentation

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

Specifications

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

Schemas & Data

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

Other Resources

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

OpenAPI Specification

shopify-refunds-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Shopify Admin REST About Refunds 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: Refunds
paths:
  /admin/api/2020-01/orders/{order_id}/refunds.json:
    get:
      summary: Shopify Retrieves A List Of Refunds For An Order
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2020-01
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: query
        name: limit
        description: "The maximum number of results to retrieve.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      - in: query
        name: in_shop_currency
        description: "Show amounts in the shop currency for the underlying transaction.\n                  (default: false)"
        schema: {}
        required: false
      tags:
      - Refunds
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_orders_param_order_id_refunds
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/orders/{order_id}/refunds.json:
    get:
      summary: Shopify Retrieves A List Of Refunds For An Order
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2020-04
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: query
        name: limit
        description: "The maximum number of results to retrieve.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      - in: query
        name: in_shop_currency
        description: "Show amounts in the shop currency for the underlying transaction.\n                  (default: false)"
        schema: {}
        required: false
      tags:
      - Refunds
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_orders_param_order_id_refunds
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/orders/{order_id}/refunds.json:
    get:
      summary: Shopify Retrieves A List Of Refunds For An Order
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2020-07
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: query
        name: limit
        description: "The maximum number of results to retrieve.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      - in: query
        name: in_shop_currency
        description: "Show amounts in the shop currency for the underlying transaction.\n                  (default: false)"
        schema: {}
        required: false
      tags:
      - Refunds
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_orders_param_order_id_refunds
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/orders/{order_id}/refunds.json:
    get:
      summary: Shopify Retrieves A List Of Refunds For An Order
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2020-10
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: query
        name: limit
        description: "The maximum number of results to retrieve.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      - in: query
        name: in_shop_currency
        description: "Show amounts in the shop currency for the underlying transaction.\n                  (default: false)"
        schema: {}
        required: false
      tags:
      - Refunds
      responses:
        '200':
          description: ''
      operationId: get_orders_param_order_id_refunds
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/orders/{order_id}/refunds.json:
    get:
      summary: Shopify Retrieves A List Of Refunds For An Order
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2021-01
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: query
        name: limit
        description: "The maximum number of results to retrieve.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      - in: query
        name: in_shop_currency
        description: "Show amounts in the shop currency for the underlying transaction.\n                  (default: false)"
        schema: {}
        required: false
      tags:
      - Refunds
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_orders_param_order_id_refunds
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/orders/{order_id}/refunds.json:
    get:
      summary: Shopify Retrieves A List Of Refunds For An Order
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-unstable
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: query
        name: limit
        description: "The maximum number of results to retrieve.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      - in: query
        name: in_shop_currency
        description: "Show amounts in the shop currency for the underlying transaction.\n                  (default: false)"
        schema: {}
        required: false
      tags:
      - Refunds
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_orders_param_order_id_refunds
      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