Uptime serviços Zydon

Address

List all addresses given an partner ID

get
Autorizações
Parâmetros de rota
partner_idstringObrigatório
Parâmetros de consulta
searchstringOpcionalDefault: ""
pageinteger · int32OpcionalDefault: 0
perPageinteger · int32OpcionalDefault: 25
sortstringOpcionalDefault: mainAddress
dirstringOpcionalDefault: desc
Respostas
200
OK
application/json
get
GET /api/sales/partners/{partner_id}/address HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*

{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "text",
      "partner_id": "text",
      "name": "text",
      "address_type": "text",
      "street": "text",
      "number": "text",
      "complement": "text",
      "contact_number": "text",
      "contact_name": "text",
      "neighborhood": "text",
      "state": "text",
      "country": "text",
      "city": "text",
      "postal_code": "text",
      "main_address": true
    }
  ]
}

Create a new partner address

post
Autorizações
Parâmetros de rota
partner_idstringObrigatório
Corpo
idstringOpcional
namestringOpcional
address_typestringOpcional
streetstringOpcional
numberstringOpcional
complementstringOpcional
contact_numberstringOpcional
contact_namestringOpcional
neighborhoodstringOpcional
statestringOpcional
countrystringOpcional
citystringOpcional
postal_codestringOpcional
main_addressbooleanOpcional
Respostas
201
PartnerAddress created successfully
application/json
post
POST /api/sales/partners/{partner_id}/address HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "id": "text",
  "name": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "contact_number": "text",
  "contact_name": "text",
  "neighborhood": "text",
  "state": "text",
  "country": "text",
  "city": "text",
  "postal_code": "text",
  "main_address": true
}
{
  "id": "text",
  "partner_id": "text",
  "name": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "contact_number": "text",
  "contact_name": "text",
  "neighborhood": "text",
  "state": "text",
  "country": "text",
  "city": "text",
  "postal_code": "text",
  "main_address": true
}

Update an existing partner address

put
Autorizações
Parâmetros de rota
partner_idstringObrigatório
Corpo
idstringOpcional
namestringOpcional
address_typestringOpcional
streetstringOpcional
numberstringOpcional
complementstringOpcional
contact_numberstringOpcional
contact_namestringOpcional
neighborhoodstringOpcional
statestringOpcional
countrystringOpcional
citystringOpcional
postal_codestringOpcional
main_addressbooleanOpcional
Respostas
200
PartnerAddress updated successfully
application/json
put
PUT /api/sales/partners/{partner_id}/address HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "id": "text",
  "name": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "contact_number": "text",
  "contact_name": "text",
  "neighborhood": "text",
  "state": "text",
  "country": "text",
  "city": "text",
  "postal_code": "text",
  "main_address": true
}
{
  "id": "text",
  "partner_id": "text",
  "name": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "contact_number": "text",
  "contact_name": "text",
  "neighborhood": "text",
  "state": "text",
  "country": "text",
  "city": "text",
  "postal_code": "text",
  "main_address": true
}

Retrieve a PartnerAddress given an ID

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

{
  "id": "text",
  "partner_id": "text",
  "name": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "contact_number": "text",
  "contact_name": "text",
  "neighborhood": "text",
  "state": "text",
  "country": "text",
  "city": "text",
  "postal_code": "text",
  "main_address": true
}

Remove a PartnerAddress given an ID

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

{}