Sign in

v1

latestOpenAPI 3.0.12026-07-24373659.1 KB
Transportadoras

Atualizar transportadora

put/api/v1/shippingCompanies/{id}

Path parameters

idinteger required

Identificador único da transportadora no Base.

Request body

namestring required

Nome da transportadora.

cpfCnpjstring required

CPF ou CNPJ da transportadora.

emailstring

Email da transportadora.

phonestring

Fone fixo.

mobilePhonestring

Fone celular.

externalReferencestring

Identificador único da transportadora no seu sistema.

observationsstring

Observações adicionais.

Example request

{
  "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"
}

Response

OK

namestring required

Nome da transportadora.

cpfCnpjstring required

CPF ou CNPJ da transportadora.

emailstring

Email da transportadora.

phonestring

Fone fixo.

mobilePhonestring

Fone celular.

externalReferencestring

Identificador único da transportadora no seu sistema.

observationsstring

Observações adicionais.

idinteger

Identificador único da transportadora no Base.

deletedboolean

Transportadora excluida True/False

asaasIdstring

Identificador único da transportadora no Asaas.

Example response

{
  "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"
}