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

# Deactivate a product

> Sets a product's `status` to `DEACTIVATED`.

Only organization admins can deactivate a product, and only an `ACTIVE` one: deactivating a product that is already `DEACTIVATED` is rejected. A product that still has active payment links can't be deactivated: end those links first. This is how a product is retired, since products can't be deleted. To bring one back, use `POST /realms/{realmId}/organizations/{organizationId}/products/{productId}/activate`.

Answers the product as it is after the change. The request has no body: if your HTTP client sends `Content-Type: application/json`, send `{}`.


## OpenAPI

````yaml /api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products/{productId}/deactivate
openapi: 3.0.3
info:
  title: Registry
  version: 1.0.0
  description: >-
    Portão 3 registry API. Every endpoint requires a bearer token in the
    Authorization header (Authorization: Bearer <token>) unless its page states
    otherwise; see the Authentication guide. That requirement is not repeated
    per endpoint. Generated by tools/openapi from code (routes + security) and
    the hand-written spec (request/response bodies). Confidence tiers:
    generated:typed=37 copied:manual=0 unknown=0.
servers:
  - url: https://api.registry.v2.portao3.com.br/
    description: production
  - url: https://api.registry.dev.3pers.com.br/
    description: development
security: []
tags:
  - name: Customers
  - name: Companies
  - name: People
  - name: Products
  - name: Suppliers
paths:
  /realms/{realmId}/organizations/{organizationId}/products/{productId}/deactivate:
    post:
      tags:
        - Products
      summary: Deactivate a product
      description: Sets a product's `status` to `DEACTIVATED`.
      operationId: >-
        postRealmsByRealmIdOrganizationsByOrganizationIdProductsByProductIdDeactivate
      parameters:
        - name: realmId
          in: path
          required: true
          description: |-
            ID of your realm.

            Format: `UUID`
          schema:
            type: string
            format: uuid
          example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b
        - name: organizationId
          in: path
          required: true
          description: |-
            ID of the organization the product belongs to.

            Format: `UUID`
          schema:
            type: string
            format: uuid
          example: c4bd3f21-dfbd-44e8-8055-68ba15bed410
        - name: productId
          in: path
          required: true
          description: |-
            ID of the product (`id` in the product list).

            Format: `UUID`
          schema:
            type: string
            format: uuid
          example: 9b2f6c1e-3d4a-4f7b-8e21-5a6c7d8e9f01
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: ID of the product.
                    example: 9b2f6c1e-3d4a-4f7b-8e21-5a6c7d8e9f01
                  realmId:
                    type: string
                    description: ID of the realm the product belongs to.
                    example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b
                    format: uuid
                  organizationId:
                    type: string
                    description: ID of the organization the product belongs to.
                    example: c4bd3f21-dfbd-44e8-8055-68ba15bed410
                    format: uuid
                  name:
                    type: string
                    description: Name of the product or service.
                    example: Consultoria em logística
                  description:
                    type: string
                    description: Free-text description. Empty when none was given.
                    example: Hora técnica de consultoria em logística e roteirização.
                  value:
                    type: number
                    description: 'Price in centavos: `15000` is R$ 150,00.'
                    example: 15000
                  skuCode:
                    type: string
                    nullable: true
                    description: >-
                      Your own stock-keeping code. Absent, or `null`, when none
                      was given.
                    example: CONS-LOG-001
                  type:
                    type: string
                    description: >-
                      `PRODUCT` for a physical good or `SERVICE` for a service.
                      Any other text a client stored is kept as sent.
                    example: SERVICE
                  status:
                    type: string
                    enum:
                      - ACTIVE
                      - DEACTIVATED
                    description: '`ACTIVE`, or `DEACTIVATED` once the product was retired.'
                    example: DEACTIVATED
                  createdAt:
                    type: string
                    description: When the product was created.
                    example: '2026-10-02T14:03:11.000Z'
                    format: date-time
                  updatedAt:
                    type: string
                    description: When the product was last changed.
                    example: '2026-10-05T09:30:00.000Z'
                    format: date-time
                required:
                  - id
                  - realmId
                  - organizationId
                  - name
                  - description
                  - value
                  - type
                  - status
                description: A product or service of the organization's catalog.
        '400':
          description: >-
            `PRODUCT_INVALID_STATUS_FOR_DEACTIVATION` — The product is already
            `DEACTIVATED`.


            `PRODUCT_HAS_ACTIVE_PAYMENT_LINKS` — The product still has active
            payment links.
          content:
            application/json:
              schema:
                type: object
                properties:
                  traceId:
                    type: string
                    description: >-
                      Identifier of the request that failed. Quote it when
                      contacting support.
                    example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                  code:
                    type: string
                    enum:
                      - PRODUCT_INVALID_STATUS_FOR_DEACTIVATION
                      - PRODUCT_HAS_ACTIVE_PAYMENT_LINKS
                    description: >-
                      Stable, machine-readable error code. Branch on this, never
                      on `message`.
                  origin:
                    type: string
                    enum:
                      - REGISTRY
                    description: Service that produced the error.
                  message:
                    type: string
                    description: >-
                      Human-readable explanation. Its wording may change without
                      notice.
                required:
                  - traceId
                  - code
                  - origin
                  - message
              example:
                traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                code: PRODUCT_INVALID_STATUS_FOR_DEACTIVATION
                origin: REGISTRY
                message: Product is already deactivated
        '403':
          description: '`FORBIDDEN_PRODUCT` — You are not an admin of the organization.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  traceId:
                    type: string
                    description: >-
                      Identifier of the request that failed. Quote it when
                      contacting support.
                    example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                  code:
                    type: string
                    enum:
                      - FORBIDDEN_PRODUCT
                    description: >-
                      Stable, machine-readable error code. Branch on this, never
                      on `message`.
                  origin:
                    type: string
                    enum:
                      - REGISTRY
                    description: Service that produced the error.
                  message:
                    type: string
                    description: >-
                      Human-readable explanation. Its wording may change without
                      notice.
                required:
                  - traceId
                  - code
                  - origin
                  - message
              example:
                traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                code: FORBIDDEN_PRODUCT
                origin: REGISTRY
                message: Forbidden
        '404':
          description: >-
            `PRODUCT_NOT_FOUND` — No product with this ID exists in the
            organization.
          content:
            application/json:
              schema:
                type: object
                properties:
                  traceId:
                    type: string
                    description: >-
                      Identifier of the request that failed. Quote it when
                      contacting support.
                    example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                  code:
                    type: string
                    enum:
                      - PRODUCT_NOT_FOUND
                    description: >-
                      Stable, machine-readable error code. Branch on this, never
                      on `message`.
                  origin:
                    type: string
                    enum:
                      - REGISTRY
                    description: Service that produced the error.
                  message:
                    type: string
                    description: >-
                      Human-readable explanation. Its wording may change without
                      notice.
                required:
                  - traceId
                  - code
                  - origin
                  - message
              example:
                traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                code: PRODUCT_NOT_FOUND
                origin: REGISTRY
                message: Product not found
        '422':
          description: >-
            `BAD_REQUEST` — A path parameter is not valid, such as a `productId`
            that is not a UUID; `fields` lists each one.
          content:
            application/json:
              schema:
                type: object
                properties:
                  traceId:
                    type: string
                    description: >-
                      Identifier of the request that failed. Quote it when
                      contacting support.
                    example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                  code:
                    type: string
                    enum:
                      - BAD_REQUEST
                    description: >-
                      Stable, machine-readable error code. Branch on this, never
                      on `message`.
                  origin:
                    type: string
                    enum:
                      - REGISTRY
                    description: Service that produced the error.
                  message:
                    type: string
                    description: >-
                      Human-readable explanation. Its wording may change without
                      notice.
                  fields:
                    type: array
                    description: >-
                      One entry per invalid request field (validation errors
                      only).
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          description: >-
                            Path of the invalid field, e.g. `label` or
                            `values[0].value`.
                          example: label
                        message:
                          type: string
                          description: Why the field was rejected.
                          example: label is required
                        code:
                          type: string
                          description: >-
                            `<FIELD>_<REASON>` — e.g. `LABEL_REQUIRED`,
                            `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`.
                          example: LABEL_REQUIRED
                        values:
                          type: array
                          items:
                            type: string
                          description: >-
                            The accepted values, when the field is an
                            enumeration.
                      required:
                        - field
                        - message
                        - code
                required:
                  - traceId
                  - code
                  - origin
                  - message
              example:
                traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                code: BAD_REQUEST
                origin: REGISTRY
                message: >-
                  Bad Request: Your request is invalid or incomplete. Please
                  make sure you are requesting with the right fields.
                fields:
                  - field: productId
                    message: Invalid UUID
                    code: PRODUCTID_UUID

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.