Magento 2 (Adobe Commerce) Products API

The Products API from Magento 2 (Adobe Commerce) — 2 operation(s) for products.

OpenAPI Specification

magento-2-products-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Adobe Commerce (Magento 2) REST Auth Products API
  description: Adobe Commerce (formerly Magento 2) exposes a REST API at the `/rest/{store-code}/V1/` (or simply `/rest/V1/`) base path for managing products, orders, customers, carts, categories, and other commerce resources. Authentication supports admin and customer integration tokens issued by the API, plus OAuth 1.0a for third-party integrations.
  version: 1.0.0
  contact:
    name: Adobe Commerce
    url: https://developer.adobe.com/commerce/webapi/rest/
servers:
- url: https://{host}/rest/{storeCode}
  description: Adobe Commerce instance (replace {host} with your storefront and {storeCode} with `V1` or e.g. `default`)
  variables:
    host:
      default: example.com
    storeCode:
      default: V1
security:
- BearerAuth: []
tags:
- name: Products
paths:
  /V1/products:
    get:
      tags:
      - Products
      summary: Search products
      operationId: searchProducts
      parameters:
      - name: searchCriteria
        in: query
        required: false
        schema:
          type: object
      responses:
        '200':
          description: Product search results
    post:
      tags:
      - Products
      summary: Create a product
      operationId: createProduct
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Created product
  /V1/products/{sku}:
    get:
      tags:
      - Products
      summary: Get product by SKU
      operationId: getProduct
      parameters:
      - name: sku
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Product
    put:
      tags:
      - Products
      summary: Update product by SKU
      operationId: updateProduct
      parameters:
      - name: sku
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Updated product
    delete:
      tags:
      - Products
      summary: Delete product by SKU
      operationId: deleteProduct
      parameters:
      - name: sku
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Deleted
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Bearer token obtained from /V1/integration/admin/token or /V1/integration/customer/token.