Sign in

v1

latestOpenAPI 3.0.12026-07-24373659.1 KB
Transportadoras

Lista transportadoras

get/api/v1/shippingCompanies

Query parameters

namestring

Nome da transportadora.

emailstring

Email da transportadora.

cpfCnpjstring

CPF ou CNPJ da transportadora.

externalReferencestring

Identificador único da transportadora no seu sistema.

asaasIdstring

Identificador único da transportadora no Asaas.

pageinteger

Página inicial da lista (0->primeira página).

sizeinteger

Número de elementos da página (max: 100).

Response

OK

totalElementsinteger
totalPagesinteger
lastboolean
numberOfElementsinteger
firstboolean
sizeinteger
numberinteger
emptyboolean

Example response

{
  "content": [
    {
      "name": "Transporte John Doe",
      "cpfCnpj": "24971563791",
      "email": "john.doe.transporte@asaas.com",
      "phone": "4738010916",
      "mobilePhone": "4799376635",
      "address": {
        "postalCode": "01310001",
        "address": "Av. Paulista, lado B",
        "addressNumber": "100",
        "complement": "Sala 01",
        "province": "Centro",
        "cityName": "São Paulo",
        "stateAbbrev": "SP",
        "country": "Brasil"
      },
      "externalReference": "12987380",
      "id": 109988771,
      "asaasId": "cus_0001919179"
    }
  ]
}