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

# Update a product



## OpenAPI

````yaml /api-reference/commerce-v1.openapi.json patch /v1/commerce/products/{id}
openapi: 3.0.3
info:
  description: >-
    Public REST API for COPE vendor integrations. Authenticate with a COPE API
    key or Clerk bearer token and call the endpoints described below.
  title: COPE Public API
  version: v1
servers:
  - description: Production
    url: https://api.cope.com
security:
  - cope_sk: []
paths:
  /v1/commerce/products/{id}:
    patch:
      tags:
        - Products
      summary: Update a product
      operationId: updateCommerceProduct
      parameters:
        - description: id public identifier.
          example: prd_A1b2C3d4E5f6G7h8
          in: path
          name: id
          required: true
          schema:
            example: prd_A1b2C3d4E5f6G7h8
            pattern: ^prd_[A-Za-z0-9]{16}$
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                product:
                  properties:
                    name:
                      type: string
                  required:
                    - name
                  type: object
              required:
                - product
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    additionalProperties: false
                    properties:
                      approval_status:
                        enum:
                          - review
                          - approved
                          - denied
                          - approved_changed
                          - denied_changed
                        type: string
                      attachments:
                        items:
                          additionalProperties: false
                          properties:
                            access_pending:
                              type: boolean
                            access_trial:
                              type: boolean
                            byte_size:
                              nullable: true
                              type: integer
                            content_type:
                              nullable: true
                              type: string
                            filename:
                              type: string
                            id:
                              example: att_A1b2C3d4E5f6G7h8
                              pattern: ^att_[A-Za-z0-9]{16}$
                              type: string
                            kind:
                              type: string
                            url:
                              nullable: true
                              type: string
                          required:
                            - id
                            - kind
                            - filename
                            - content_type
                            - byte_size
                            - url
                            - access_trial
                            - access_pending
                          type: object
                        type: array
                      created_at:
                        type: string
                      description:
                        type: string
                      headline:
                        nullable: true
                        type: string
                      id:
                        example: prd_A1b2C3d4E5f6G7h8
                        pattern: ^prd_[A-Za-z0-9]{16}$
                        type: string
                      images:
                        items:
                          additionalProperties: false
                          properties:
                            byte_size:
                              nullable: true
                              type: integer
                            content_type:
                              nullable: true
                              type: string
                            filename:
                              type: string
                            id:
                              example: img_A1b2C3d4E5f6G7h8
                              pattern: ^img_[A-Za-z0-9]{16}$
                              type: string
                            kind:
                              type: string
                            thumbnail_url:
                              nullable: true
                              type: string
                            url:
                              nullable: true
                              type: string
                          required:
                            - id
                            - kind
                            - filename
                            - content_type
                            - byte_size
                            - url
                            - thumbnail_url
                          type: object
                        type: array
                      name:
                        type: string
                      payment_plans:
                        items:
                          additionalProperties: false
                          properties:
                            currency:
                              type: string
                            display_name:
                              type: string
                            first_payment_amount_cents:
                              type: integer
                            interval:
                              type: string
                            interval_count:
                              description: >-
                                For recurring plans, interval x interval_count
                                is the billing period and may not exceed 2
                                years. Configurations over the cap are rejected
                                with code interval_exceeds_max.
                              type: integer
                            next_payments_amount_cents:
                              type: integer
                            next_payments_count:
                              nullable: true
                              type: integer
                            plan_type:
                              type: string
                            position:
                              type: integer
                            shipping_price_cents:
                              type: integer
                          required:
                            - currency
                            - display_name
                            - first_payment_amount_cents
                            - interval
                            - interval_count
                            - next_payments_amount_cents
                            - next_payments_count
                            - plan_type
                            - position
                            - shipping_price_cents
                          type: object
                        type: array
                      product_type:
                        type: string
                      product_url:
                        nullable: true
                        type: string
                      quantity:
                        type: integer
                      quantity_selection_enabled:
                        type: boolean
                      requires_shipping:
                        type: boolean
                      status:
                        enum:
                          - active
                          - inactive
                          - archived
                        type: string
                      stock_level:
                        additionalProperties: false
                        nullable: true
                        properties:
                          available_stock:
                            type: integer
                          visibility:
                            type: string
                        required:
                          - available_stock
                          - visibility
                        type: object
                      stock_level_settings_enabled:
                        type: boolean
                      tags:
                        items:
                          type: string
                        type: array
                      trial_period_days:
                        type: integer
                      updated_at:
                        type: string
                    required:
                      - attachments
                      - created_at
                      - description
                      - headline
                      - id
                      - images
                      - name
                      - payment_plans
                      - product_type
                      - product_url
                      - quantity
                      - quantity_selection_enabled
                      - requires_shipping
                      - status
                      - approval_status
                      - stock_level
                      - stock_level_settings_enabled
                      - tags
                      - trial_period_days
                      - updated_at
                    type: object
                required:
                  - data
                type: object
          description: Successful response
        '400':
          content:
            application/problem+json:
              examples:
                invalid_request:
                  summary: Invalid request
                  value:
                    code: invalid_request
                    detail: null
                    errors:
                      - code: missing
                        detail: 'param is missing or the value is empty: product_id'
                        param: product_id
                    request_id: req_123
                    status: 400
                    title: Invalid Request
                    type: https://docs.cope.com/errors/invalid_request
              schema:
                $ref: '#/components/schemas/PublicProblemDetail'
          description: Invalid request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/PublicProblemDetail'
          description: Missing or invalid bearer token
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/PublicProblemDetail'
          description: Bearer token is not authorized for this route
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/PublicProblemDetail'
          description: Resource not found
        '422':
          content:
            application/problem+json:
              examples:
                product_has_active_offers:
                  summary: Product has active offers
                  value:
                    code: product_has_active_offers
                    detail: Cannot archive product with active phone offers
                    errors:
                      - code: product_has_active_offers
                        detail: Cannot archive product with active phone offers
                    request_id: req_123
                    status: 422
                    title: Product Has Active Offers
                    type: https://docs.cope.com/errors/product_has_active_offers
                validation_failed:
                  summary: Validation failed
                  value:
                    code: validation_failed
                    detail: null
                    errors:
                      - code: blank
                        detail: Name can't be blank
                        param: name
                    request_id: req_123
                    status: 422
                    title: Validation Failed
                    type: https://docs.cope.com/errors/validation_failed
              schema:
                $ref: '#/components/schemas/PublicProblemDetail'
          description: Public commerce validation problem
      security:
        - cope_sk: []
components:
  schemas:
    PublicProblemDetail:
      additionalProperties: false
      properties:
        code:
          type: string
        detail:
          nullable: true
          type: string
        errors:
          items:
            additionalProperties: false
            properties:
              code:
                type: string
              detail:
                type: string
              param:
                type: string
            required:
              - code
              - detail
            type: object
          type: array
        request_id:
          type: string
        status:
          type: integer
        title:
          type: string
        type:
          type: string
      required:
        - type
        - title
        - status
        - code
        - request_id
      type: object
  securitySchemes:
    cope_sk:
      description: >-
        Bearer credential for the public API. Vendor integrations should send a
        live COPE API key (`cope_sk_live_*`). Clerk bearer tokens are also
        accepted when paired with `X-Cope-Business-Id`.
      scheme: bearer
      type: http

````