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

# List Upsells

> Lista os upsells da loja.



## OpenAPI

````yaml /openapi/upsells.yaml get /app/upsell
openapi: 3.1.0
info:
  title: CentralCart API
  version: 1.0.0
servers:
  - url: https://api.centralcart.io/v1
    description: Produção
security:
  - bearerAuth: []
paths:
  /app/upsell:
    get:
      tags:
        - Upsells
      summary: List Upsells
      description: Lista os upsells da loja.
      operationId: listUpsells
      parameters:
        - name: package_id
          in: query
          required: false
          description: Filtra os upsells em que o produto é o ofertado ou um dos gatilhos.
          schema:
            type: number
      responses:
        '200':
          description: Lista de upsells, na ordem de exibição.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Upsell'
              example:
                - id: 12
                  store_id: 2
                  offered_package_id: 305
                  type: ADDITIONAL
                  all_triggers: false
                  offer_price: 9.9
                  position: 0
                  enabled: true
                  created_at: '2026-09-28T14:02:11.000-03:00'
                  updated_at: '2026-09-28T14:02:11.000-03:00'
                  offered:
                    id: 305
                    name: Kit Inicial
                    image: https://cdn.centralcart.io/stores/2/kit-inicial.png
                    price: 14.9
                    slug: kit-inicial
                  triggers:
                    - id: 301
                      name: VIP Mensal
                      image: https://cdn.centralcart.io/stores/2/vip-mensal.png
                      price: 29.9
                      slug: vip-mensal
components:
  schemas:
    Upsell:
      type: object
      properties:
        id:
          type: number
          description: ID do upsell
        store_id:
          type: number
          description: ID da loja
        offered_package_id:
          type: number
          description: ID do produto ofertado
        type:
          type: string
          enum:
            - ADDITIONAL
            - ALTERNATIVE
            - POST_SALE
          description: >-
            `ADDITIONAL` soma ao carrinho, `ALTERNATIVE` troca o gatilho pelo
            ofertado (upgrade) e `POST_SALE` aparece depois da compra
        all_triggers:
          type: boolean
          description: Indica se qualquer produto do carrinho dispara a oferta
        offer_price:
          type: number
          nullable: true
          description: Preço do produto ofertado nesta oferta. `null` usa o preço normal
        position:
          type: number
          description: Ordem de exibição, do menor para o maior
        enabled:
          type: boolean
          description: Indica se o upsell está ativado
        created_at:
          type: string
          description: Data de criação
        updated_at:
          type: string
          description: Data da última atualização
        offered:
          $ref: '#/components/schemas/UpsellPackage'
        triggers:
          type: array
          description: Produtos que disparam a oferta. Vazio quando `all_triggers` é `true`
          items:
            $ref: '#/components/schemas/UpsellPackage'
    UpsellPackage:
      type: object
      properties:
        id:
          type: number
          description: ID do produto
        name:
          type: string
          description: Nome do produto
        image:
          type: string
          nullable: true
          description: URL da imagem do produto
        price:
          type: number
          description: Preço normal do produto
        slug:
          type: string
          description: Slug do produto
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Token de API gerado no painel da CentralCart.

````

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