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

# Obter upsell

> Retorna a oferta pelo id, quando ela pertence à conta da chave. Ao contrário da listagem, esta rota também resolve um downsell, então um id lido de um funil pode ser consultado aqui. Uma oferta de outra conta responde `404`. Exige o escopo `upsells:read`.



## OpenAPI

````yaml /apps/seller/openapi.json get /public/upsells/{id}
openapi: 3.1.0
info:
  title: SpeedSellX API
  version: 2.0.0
  description: >-
    API pública da SpeedSellX para consultar e atualizar, por integração, os
    dados da sua conta: produtos, pedidos, reembolsos, chargebacks, checkouts,
    upsells, webhooks, assinaturas, vendas e métricas.


    Autentique com `Authorization: Bearer sk_live_...` e gere chaves no painel,
    em Desenvolvedores. Requisições que alteram dados exigem o header
    `Idempotency-Key`. Listagens aceitam `page`/`per_page` (padrão 15) e
    retornam `{ data, links, meta }`.
servers:
  - url: https://api.speedsellx.io/v2
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Ping
    description: A chamada que prova que a chave funciona.
  - name: Pedidos
    description: Os pedidos da conta da chave.
  - name: Reembolsos
    description: Os pedidos de reembolso da conta da chave.
  - name: Produtos
    description: >-
      O catálogo da conta da chave: leitura, criação, substituição, preço e
      arquivamento.
  - name: Checkouts
    description: Os checkouts da conta da chave e a personalização deles.
  - name: Assinaturas
    description: As assinaturas recorrentes da conta da chave.
  - name: Upsells
    description: As ofertas de upsell da conta da chave.
  - name: Métricas
    description: Os agregados da conta da chave.
  - name: Vendas
    description: O resumo de vendas pagas por janela de datas.
  - name: Chargebacks
    description: Os chargebacks abertos contra a conta da chave.
  - name: Webhooks
    description: As assinaturas de webhook da conta da chave.
paths:
  /public/upsells/{id}:
    get:
      tags:
        - Upsells
      summary: Obter upsell
      description: >-
        Retorna a oferta pelo id, quando ela pertence à conta da chave. Ao
        contrário da listagem, esta rota também resolve um downsell, então um id
        lido de um funil pode ser consultado aqui. Uma oferta de outra conta
        responde `404`. Exige o escopo `upsells:read`.
      operationId: publicapi.upsells.show
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: '`ApiUpsellResource`'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ApiUpsellResource'
                required:
                  - data
        '401':
          description: Chave ausente, inválida ou revogada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    const: error
                  error:
                    type: string
                    const: unauthenticated
                required:
                  - status
                  - error
        '403':
          description: A chave não tem o escopo que a rota exige.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    const: error
                  error:
                    type: string
                    const: insufficient_scope
                required:
                  - status
                  - error
        '404':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    const: error
                  error:
                    type: string
                    const: not_found
                required:
                  - status
                  - error
        '429':
          description: Limite de requisições por minuto excedido para esta chave.
components:
  schemas:
    ApiUpsellResource:
      type: object
      properties:
        id:
          type: integer
        seller_id:
          type: integer
        funnel_id:
          type:
            - integer
            - 'null'
        product_id:
          type:
            - integer
            - 'null'
        product_link_id:
          type:
            - integer
            - 'null'
        name:
          type:
            - string
            - 'null'
        status:
          type: string
        accept_text:
          type:
            - string
            - 'null'
        refuse_text:
          type:
            - string
            - 'null'
        accept_page:
          type:
            - string
            - 'null'
        refuse_page:
          type:
            - string
            - 'null'
        accept_redirect:
          type:
            - string
            - 'null'
        refuse_redirect:
          type:
            - string
            - 'null'
        created_at:
          type:
            - string
            - 'null'
        updated_at:
          type:
            - string
            - 'null'
      required:
        - id
        - seller_id
        - funnel_id
        - product_id
        - product_link_id
        - name
        - status
        - accept_text
        - refuse_text
        - accept_page
        - refuse_page
        - accept_redirect
        - refuse_redirect
        - created_at
        - updated_at
      title: ApiUpsellResource
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A chave de API da conta, no formato `sk_{modo}_{prefixo}.{segredo}`.

````