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

# Listar pedidos

> Lista paginada de pedidos com filtros por estado, método de pagamento e período. Cada pedido carrega o pagamento associado e o comprador.



## OpenAPI

````yaml /openapi/korbit-public-v1.json get /v1/orders
openapi: 3.1.0
info:
  title: Korbit API
  version: 1.0.0
  description: >-
    API de pagamentos da Korbit para merchants: PIX, cartão (com 3DS),
    assinaturas, checkout por link, payouts, antecipações e refunds — com
    idempotência, webhooks assinados e ambiente sandbox.
  contact:
    name: Suporte Korbit
    email: suporte@korbit.com.br
servers:
  - url: https://api.korbit.com.br
    description: Produção (chaves kbt_live_)
  - url: https://api-test.korbit.com.br
    description: Sandbox (chaves kbt_test_)
security:
  - bearerAuth: []
tags:
  - name: Antecipações
  - name: Assinaturas
  - name: Atividade
  - name: Catálogo
  - name: Chaves de API
  - name: Checkout
  - name: Clientes e Pedidos
  - name: Pagamentos
  - name: Refunds e Disputas
  - name: Saldo e Saques
  - name: Sandbox
  - name: Webhooks
paths:
  /v1/orders:
    get:
      tags:
        - Clientes e Pedidos
      summary: Listar pedidos
      description: >-
        Lista paginada de pedidos com filtros por estado, método de pagamento e
        período. Cada pedido carrega o pagamento associado e o comprador.
      operationId: listCommerceOrders
      parameters:
        - schema:
            type: string
            maxLength: 200
          in: query
          name: after
          required: false
        - schema:
            type: string
            format: uuid
          in: query
          name: customerId
          required: false
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          in: query
          name: limit
          required: false
        - schema:
            type: string
            enum:
              - PIX
              - CARD
          in: query
          name: paymentMethod
          required: false
        - schema:
            type: string
            minLength: 1
            maxLength: 200
          in: query
          name: search
          required: false
        - schema:
            type: string
            enum:
              - PAYMENT_PENDING
              - AWAITING_PAYMENT
              - PAID
              - PAYMENT_FAILED
              - CANCELED
              - EXPIRED
          in: query
          name: status
          required: false
        - schema:
            type: string
            enum:
              - ALL
              - CHARGEBACKS
              - MED
              - REFUNDS
              - SALES
          in: query
          name: view
          required: false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - data
                  - hasMore
                  - nextCursor
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      additionalProperties: false
                      required:
                        - amountMinor
                        - buyerEmail
                        - buyerName
                        - clientReferenceId
                        - createdAt
                        - currency
                        - customerId
                        - id
                        - offerId
                        - category
                        - dispute
                        - feeAmountMinor
                        - latestRefundStatus
                        - netAmountMinor
                        - offerName
                        - paidAt
                        - paymentIntentId
                        - paymentMethod
                        - productId
                        - productImageUrl
                        - productName
                        - refundedAmountMinor
                        - refundingAmountMinor
                        - status
                        - subscriptionId
                        - updatedAt
                      properties:
                        category:
                          type: string
                          enum:
                            - CHARGEBACK
                            - MED
                            - OTHER
                            - REFUND
                            - SALE
                        dispute:
                          anyOf:
                            - type: object
                              additionalProperties: false
                              required:
                                - id
                                - kind
                                - status
                              properties:
                                id:
                                  type: string
                                  format: uuid
                                kind:
                                  type: string
                                  enum:
                                    - CARD_CHARGEBACK
                                    - PIX_MED
                                status:
                                  type: string
                            - type: 'null'
                        feeAmountMinor:
                          anyOf:
                            - type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            - type: 'null'
                        latestRefundStatus:
                          anyOf:
                            - type: string
                              enum:
                                - MERCHANT_REVIEW
                                - KORBIT_REVIEW
                                - APPROVED_FOR_EXECUTION
                                - FUNDING_REQUIRED
                                - PROCESSING
                                - SUCCEEDED
                                - FAILED
                            - type: 'null'
                        netAmountMinor:
                          anyOf:
                            - type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            - type: 'null'
                        paymentIntentId:
                          anyOf:
                            - type: string
                              format: uuid
                            - type: 'null'
                        refundedAmountMinor:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        refundingAmountMinor:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        amountMinor:
                          type: integer
                          minimum: 1
                          maximum: 9007199254740991
                        buyerEmail:
                          type: string
                          format: email
                          maxLength: 320
                        buyerName:
                          anyOf:
                            - type: string
                              maxLength: 200
                            - type: 'null'
                        clientReferenceId:
                          anyOf:
                            - type: string
                              maxLength: 128
                            - type: 'null'
                        createdAt:
                          type: string
                          format: date-time
                        currency:
                          type: string
                          enum:
                            - BRL
                        customerId:
                          type: string
                          format: uuid
                        id:
                          type: string
                          format: uuid
                        offerId:
                          type: string
                          format: uuid
                        offerName:
                          type: string
                          minLength: 1
                          maxLength: 120
                        paidAt:
                          anyOf:
                            - type: string
                              format: date-time
                            - type: 'null'
                        paymentMethod:
                          type: string
                          enum:
                            - PIX
                            - CARD
                        productId:
                          type: string
                          format: uuid
                        productImageUrl:
                          anyOf:
                            - type: string
                              maxLength: 2048
                            - type: 'null'
                        productName:
                          type: string
                          minLength: 1
                          maxLength: 120
                        status:
                          type: string
                          enum:
                            - PAYMENT_PENDING
                            - AWAITING_PAYMENT
                            - PAID
                            - PAYMENT_FAILED
                            - CANCELED
                            - EXPIRED
                        subscriptionId:
                          anyOf:
                            - type: string
                              format: uuid
                            - type: 'null'
                        updatedAt:
                          type: string
                          format: date-time
                  hasMore:
                    type: boolean
                  nextCursor:
                    anyOf:
                      - type: string
                        maxLength: 200
                      - type: 'null'
                  total:
                    type: integer
                    minimum: 0
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
        '429':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Korbit API key

````

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