Uptime serviços Zydon

Companies

Obter Empresa

get
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
200
OK
application/json
get
GET /api/sales/companies/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*

{
  "id": "text",
  "name": "text",
  "fiscal_registration_number": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "neighborhood": "text",
  "state": "text",
  "country": "text",
  "active": true,
  "postal_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Atualizar Empresa

put
Autorizações
Parâmetros de rota
idstringObrigatório
Corpo
namestringObrigatório
fiscal_registration_numberstringObrigatório
address_typestringObrigatório
streetstringObrigatório
numberstringObrigatório
complementstringObrigatório
neighborhoodstringObrigatório
statestringObrigatório
countrystringObrigatório
activebooleanObrigatório
postal_codestringObrigatório
Respostas
200
Company updated successfully
application/json
put
PUT /api/sales/companies/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 258

{
  "name": "text",
  "fiscal_registration_number": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "neighborhood": "text",
  "state": "text",
  "country": "text",
  "active": true,
  "postal_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}
{
  "id": "text",
  "name": "text",
  "fiscal_registration_number": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "neighborhood": "text",
  "state": "text",
  "country": "text",
  "active": true,
  "postal_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Remover Empresa

delete
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
204
Company removed successfully
application/json
delete
DELETE /api/sales/companies/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*

{
  "id": "text"
}

Listar Empresas

get
Autorizações
Parâmetros de consulta
searchstringOpcionalDefault: ""
pageinteger · int32OpcionalDefault: 0
perPageinteger · int32OpcionalDefault: 25
sortstringOpcionalDefault: ""
dirstringOpcionalDefault: asc
Respostas
200
OK
application/json
get
GET /api/sales/companies HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*

{
  "id": "text",
  "name": "text",
  "fiscal_registration_number": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "neighborhood": "text",
  "state": "text",
  "country": "text",
  "active": true,
  "postal_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Criar Empresa

post
Autorizações
Corpo
idstringOpcional
namestringObrigatório
fiscal_registration_numberstringObrigatório
address_typestringObrigatório
streetstringObrigatório
numberstringObrigatório
complementstringObrigatório
neighborhoodstringObrigatório
statestringObrigatório
countrystringObrigatório
activebooleanObrigatório
postal_codestringObrigatório
Respostas
201
Company created successfully
application/json
post
POST /api/sales/companies HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 270

{
  "id": "text",
  "name": "text",
  "fiscal_registration_number": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "neighborhood": "text",
  "state": "text",
  "country": "text",
  "active": true,
  "postal_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}
{
  "id": "text",
  "name": "text",
  "fiscal_registration_number": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "neighborhood": "text",
  "state": "text",
  "country": "text",
  "active": true,
  "postal_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}