---
title: "Listar pedidos"
method: GET
path: "/api/v1/salesOrders"
tags: ["Pedidos"]
---

# Listar pedidos

`GET /api/v1/salesOrders`

## Query parameters

- `number` integer
- `issueStartDate` string
- `issueEndDate` string
- `customerId` integer
- `externalReference` string
- `page` integer
- `size` integer

## Response `200`

OK

- PageSalesOrderOutputDto
  - `totalElements` integer
  - `totalPages` integer
  - `last` boolean
  - `pageable` PageableObject
    - `paged` boolean
    - `unpaged` boolean
    - `pageSize` integer
    - `pageNumber` integer
    - `offset` integer
    - `sort` SortObject[]
      - `direction` string
      - `nullHandling` string
      - `ascending` boolean
      - `property` string
      - `ignoreCase` boolean
  - `numberOfElements` integer
  - `first` boolean
  - `size` integer
  - `content` SalesOrderOutputDto[]
    - `number` integer — Número do pedido de venda.
    - `issueDate` string, date, required — Data de emissão do pedido.
    - `customerId` integer, required — Identificador único do cliente no Base.
    - `observations` string — Observações adicionais.
    - `externalReference` string — Identificador único do pedido no seu sistema.
    - `typeOfShipping` 'EMITENTE' | 'DESTINATARIO' | 'TERCEIROS' | 'SEM_FRETE' — Modalidade do frete.
    - `shippingCompanyId` integer — Identificador único da transportadora no Base.
    - `costOfShipping` number — Valor total do frete para o pedido.
    - `discountValue` number — Valor total desconto para o pedido.
    - `orderItems` SalesOrderItemOutputDto[] — Itens do pedido.
      - `productId` integer, required — Identificador único do produto.
      - `unitPrice` number, required — Preço unitário.
      - `quantity` number, required — Quantidade.
      - `costOfShipping` number — Valor do frete do produto.
      - `discountValue` number — Valor do desconto do poduto.
      - `itemValue` number — Valor total do item.
      - `cClassTrib` string — Classificação Tributária. Este campo será considerado somente para empresas do Regime Normal. Ou seja, este campo, mesmo se preenchido, será desconsiderado para empresas do Simples Nacional e MEI.
    - `orderPayments` SalesOrderPaymentDto[] — Cobranças do pedido.
      - `dueDate` string, date, required — Data de vencimento da cobrança
      - `receiptDate` string, date — Data de recebimento da cobrança
      - `value` number, required — Valor da cobrança
      - `bankId` integer, required — Identificador único do banco no Base.
      - `billingType` 'BOLETO' | 'CREDIT_CARD' | 'DEBIT_CARD' | 'DEPOSIT' | 'PIX' | 'TRANSFER' | 'UNDEFINED', required — Forma de pagamento.
      - `paymentId` string — Identificador único da cobrança no Asaas.
      - `numberInstallments` integer — Número de parcelas da cobrança.
    - `itemsValue` number — Total dos itens.
    - `orderValue` number — Total do pedido.
    - `id` integer — Identificador único do pedido no Base.
    - `invoiceNumber` integer — Número da nota fiscal.
    - `invoiceId` integer — Identificador único da nota fiscal no Base.
    - `invoiceStatus` 'GRAVADA' | 'ENVIADA' | 'CANCELADA' | 'INUTILIZADA' | 'CONTIGENCIA' | 'PENDENTE' | 'PENDENTE_ENVIO_NOTAS' | 'PENDENTE_ENVIO_NFE_A3' | 'ENVIO_CARTA_CORRECAO' | 'EM_PROCESSO_AUTORIZACAO' | 'EM_PROCESSO_CANCELAMENTO' | 'NEGADA' | 'CANCELAMENTO_NEGADO' | 'DENEGADA' | 'ERRO_ENVIO' | 'NOTA_AUTORIZADA_DFE' | 'INICIADA' | 'PROCESSANDO' | 'EMITIDA' | 'REJEITADA' | 'AJUSTES_NECESSARIOS' — Situação da nota Fiscal.
  - `number` integer
  - `sort` SortObject[]
    - `direction` string
    - `nullHandling` string
    - `ascending` boolean
    - `property` string
    - `ignoreCase` boolean
  - `empty` boolean

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.dev/baseerp/apis/api-base-by-asaas.md) · [All operations](https://skmtc.dev/baseerp/apis/api-base-by-asaas/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/baseerp/api-base-by-asaas/revisions/408ce44b0d29/schema)