---
title: "Lista transportadoras"
method: GET
path: "/api/v1/shippingCompanies"
tags: ["Transportadoras"]
---

# Lista transportadoras

`GET /api/v1/shippingCompanies`

## Query parameters

- `name` string
- `email` string
- `cpfCnpj` string
- `externalReference` string
- `asaasId` string
- `page` integer
- `size` integer

## Response `200`

OK

- PageShippingCompaniesOutput
  - `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` ShippingCompaniesOutput[]
    - `name` string, required — Nome da transportadora.
    - `cpfCnpj` string, required — CPF ou CNPJ da transportadora.
    - `email` string — Email da transportadora.
    - `phone` string — Fone fixo.
    - `mobilePhone` string — Fone celular.
    - `address` ShippingCompaniesAddress — Logradouro.
      - `postalCode` string — CEP do endereço.
      - `address` string — Logradouro.
      - `addressNumber` string — Número do endereço.
      - `complement` string — Complemento do endereço.
      - `province` string — Bairro.
      - `cityName` string — Cidade.
      - `stateAbbrev` string — Sigla do estado.
      - `country` string — Nome do País.
    - `externalReference` string — Identificador único da transportadora no seu sistema.
    - `observations` string — Observações adicionais.
    - `id` integer — Identificador único da transportadora no Base.
    - `deleted` boolean — Transportadora excluida True/False
    - `asaasId` string — Identificador único da transportadora no Asaas.
  - `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)