> ## Documentation Index
> Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a Product

> Updates a Product



## OpenAPI

````yaml /api-reference/platform.yaml patch /api/v2/platform/products/{id}
openapi: 3.0.3
info:
  title: Platform API
  contact:
    name: Vendo Connect Inc.
    url: https://getvendo.com
    email: sales@getvendo.com
  description: Spree Platform API
  version: v2
servers:
  - url: http://{defaultHost}
    variables:
      defaultHost:
        default: localhost:3000
security: []
tags:
  - name: Addresses
  - name: Adjustments
  - name: Classifications
  - name: Countries
  - name: CMS Pages
  - name: CMS Sections
  - name: Digital Assets
  - name: Digital Links
  - name: Line Items
  - name: Menus
  - name: Menu Items
  - name: Option Types
  - name: Option Values
  - name: Orders
  - name: Payments
  - name: Payment Methods
  - name: Products
  - name: Promotions
  - name: Promotion Actions
  - name: Promotion Categories
  - name: Promotion Rules
  - name: Roles
  - name: Shipments
  - name: Shipping Categories
  - name: Shipping Methods
  - name: States
  - name: Stock Items
  - name: Stock Locations
  - name: Store Credit Categories
  - name: Store Credit Types
  - name: Store Credits
  - name: Tax Categories
  - name: Tax Rates
  - name: Taxons
  - name: Taxonomies
  - name: Users
  - name: Variants
  - name: Vendors
  - name: Webhook Events
  - name: Webhook Subscribers
  - name: Wishlists
  - name: Wished Items
  - name: Zones
paths:
  /api/v2/platform/products/{id}:
    patch:
      tags:
        - Products
      summary: Update a Product
      description: Updates a Product
      operationId: update-product
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: include
          in: query
          description: >-
            Select which associated resources you would like to fetch, see: <a
            href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>
          example: prices
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_product_params'
      responses:
        '200':
          description: Record updated
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    data:
                      id: '171'
                      type: product
                      attributes:
                        name: Twirling Bottom
                        description: >-
                          Ut quod iusto optio quos labore. Blanditiis in sunt
                          sequi dolores eveniet reprehenderit maxime. Iusto
                          consequuntur itaque nostrum placeat.

                          Laboriosam labore vero voluptatibus suscipit
                          consectetur possimus qui. Ullam commodi corporis
                          cumque voluptatem neque non explicabo. Quaerat atque
                          error nesciunt recusandae rem unde qui quas. Labore
                          perspiciatis consectetur quisquam voluptatibus
                          similique officiis ipsam enim. Labore neque
                          reprehenderit et tempore.

                          Ea minus nostrum placeat quibusdam laudantium. Illo
                          voluptates in suscipit consequatur harum. Omnis
                          tempora facilis distinctio quos repudiandae ex
                          sapiente. Amet optio temporibus voluptas doloribus.

                          Odio at porro commodi repudiandae quia quas. Ut sequi
                          atque accusamus voluptatum consequatur delectus
                          explicabo. Nobis laboriosam facere molestias
                          consectetur saepe totam eos ea. Possimus atque
                          adipisci sequi dolorum excepturi quo. Ad esse dolorum
                          accusantium fugiat quaerat.

                          Voluptas libero magnam earum reprehenderit ullam at
                          veritatis. Magni culpa id quidem hic ad. Quidem ipsum
                          est vero ut eaque veniam. Corrupti sint ratione maxime
                          aspernatur itaque quo nostrum. Qui architecto ducimus
                          quisquam iste saepe ullam.
                        available_on: '2021-11-08T19:34:54.192Z'
                        deleted_at: null
                        slug: product-1706992
                        meta_description: null
                        meta_keywords: null
                        created_at: '2022-11-08T19:34:54.210Z'
                        updated_at: '2022-11-08T19:34:54.468Z'
                        promotionable: true
                        meta_title: null
                        discontinue_on: null
                        public_metadata: {}
                        private_metadata: {}
                        status: active
                        make_active_at: '2021-11-08T19:34:54.192Z'
                        display_compare_at_price: null
                        display_price: $33.21
                        purchasable: true
                        in_stock: false
                        backorderable: true
                        available: true
                        currency: USD
                        price: '33.21'
                        compare_at_price: null
                      relationships:
                        tax_category:
                          data:
                            id: '112'
                            type: tax_category
                        primary_variant:
                          data:
                            id: '238'
                            type: variant
                        default_variant:
                          data:
                            id: '238'
                            type: variant
                        variants:
                          data: []
                        option_types:
                          data: []
                        product_properties:
                          data: []
                        taxons:
                          data: []
                        images:
                          data: []
              schema:
                $ref: '#/components/schemas/resource'
        '401':
          description: Authentication Failed
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: The access token is invalid
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: Record not found
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: The resource you were looking for could not be found.
              schema:
                $ref: '#/components/schemas/error'
        '422':
          description: Invalid request
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: Name can't be blank
                    errors:
                      name:
                        - can't be blank
              schema:
                $ref: '#/components/schemas/validation_errors'
      security:
        - bearer_auth: []
components:
  schemas:
    update_product_params:
      type: object
      properties:
        product:
          type: object
          properties:
            name:
              type: string
            description:
              type: string
            available_on:
              type: string
            discontinue_on:
              type: string
            permalink:
              type: string
            meta_description:
              type: string
            meta_keywords:
              type: string
            price:
              type: string
            sku:
              type: string
            deleted_at:
              type: string
            prototype_id:
              type: string
            option_values_hash:
              type: string
            weight:
              type: string
            height:
              type: string
            width:
              type: string
            depth:
              type: string
            shipping_category_id:
              type: string
            tax_category_id:
              type: string
            cost_currency:
              type: string
            cost_price:
              type: string
            compare_at_price:
              type: string
            option_type_ids:
              type: string
            taxon_ids:
              type: string
            public_metadata:
              type: object
            private_metadata:
              type: object
      required:
        - product
      x-internal: false
    resource:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/resource_properties'
      required:
        - data
      x-internal: false
    error:
      type: object
      properties:
        error:
          type: string
      required:
        - error
      x-internal: false
    validation_errors:
      type: object
      properties:
        error:
          type: string
        errors:
          type: object
      required:
        - error
        - errors
      x-internal: false
    resource_properties:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          type: object
        relationships:
          type: object
      required:
        - id
        - type
        - attributes
      x-internal: false
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer

````