magento Stores API

openapi: 3.1.0
info:
  title: Magento REST Authentication Stores API
  description: 'The Adobe Commerce (Magento) REST API provides a comprehensive set of endpoints for interacting with all major aspects of an e-commerce store, including catalog management, orders, customers, inventory, shipping, and payments. It supports three authentication mechanisms: OAuth 1.0a for third-party integrations, token-based authentication for mobile apps and administrators, and guest access for select public endpoints. The API follows REST conventions and returns JSON responses, enabling developers to build integrations, automate store operations, and power headless commerce storefronts. All endpoints are versioned under the /V1 prefix and support searchCriteria query parameters for filtering, sorting, and paginating collection responses.'
  version: '2.4'
  contact:
    name: Adobe Commerce Developer Support
    url: https://developer.adobe.com/commerce/webapi/rest/
  termsOfService: https://www.adobe.com/legal/terms.html
servers:
- url: https://{store_domain}/rest/{store_code}
  description: Production Server
  variables:
    store_domain:
      default: your-store.example.com
      description: The hostname of your Adobe Commerce store
    store_code:
      default: V1
      description: Store code followed by API version. Use "all" as store code for admin-scope operations, or the specific store view code for store-scoped operations. The V1 version path segment follows.
security:
- bearerAuth: []
tags:
- name: Stores
  description: Store configuration retrieval including store groups, store views, websites, and configuration settings.
paths:
  /V1/store/storeConfigs:
    get:
      operationId: listStoreConfigs
      summary: List store configurations
      description: Returns configuration data for all store views accessible to the authenticated user. Each store config entry includes the store code, base URLs, locale, timezone, currency codes, and weight unit settings. No authentication is required for this endpoint on most store configurations.
      tags:
      - Stores
      security: []
      responses:
        '200':
          description: List of store configurations
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StoreConfig'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    Unauthorized:
      description: Unauthorized — missing or invalid authentication token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      description: Standard error response returned for 4xx and 5xx responses.
      properties:
        message:
          type: string
          description: Human-readable error message.
        parameters:
          type: array
          description: Additional error context parameters.
          items:
            type: object
    StoreConfig:
      type: object
      description: Configuration settings for a store view.
      properties:
        id:
          type: integer
          description: Numeric store view entity ID.
        code:
          type: string
          description: Unique string code identifier for the store view.
        website_id:
          type: integer
          description: ID of the website this store view belongs to.
        locale:
          type: string
          description: Locale code for this store (e.g. en_US, fr_FR).
        base_currency_code:
          type: string
          description: ISO 4217 currency code for the base currency (e.g. USD).
        default_display_currency_code:
          type: string
          description: ISO 4217 currency code for the display currency.
        timezone:
          type: string
          description: Timezone identifier (e.g. America/Chicago).
        weight_unit:
          type: string
          description: Weight unit used for this store (lbs or kgs).
          enum:
          - lbs
          - kgs
        base_url:
          type: string
          format: uri
          description: Base URL of the store frontend.
        base_link_url:
          type: string
          format: uri
          description: Base link URL for the store.
        base_media_url:
          type: string
          format: uri
          description: Base URL for media assets in this store.
        secure_base_url:
          type: string
          format: uri
          description: Secure (HTTPS) base URL of the store frontend.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token obtained from the /V1/integration/admin/token or /V1/integration/customer/token endpoint. Include in the Authorization header as "Bearer {token}".
externalDocs:
  description: Adobe Commerce REST API Documentation
  url: https://developer.adobe.com/commerce/webapi/rest/