Address

List all addresses given an partner ID

get

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

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

currentPageinteger · int32Opcional

perPageinteger · int32Opcional

totalinteger · int64Opcional

404

PartnerAddress was not found

application/json

500

An internal server error was thrown

application/json

get/partners/{partner_id}/address

HTTPcURLJavaScriptPython

GET /api/sales/partners/{partner_id}/address HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
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,
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ]
}

Create a new partner address

post

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

partner_idstringObrigatório

Corpo

application/json

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

idstringOpcional

partner_idstringOpcional

namestringOpcional

address_typestringOpcional

streetstringOpcional

numberstringOpcional

complementstringOpcional

contact_numberstringOpcional

contact_namestringOpcional

neighborhoodstringOpcional

statestringOpcional

countrystringOpcional

citystringOpcional

postal_codestringOpcional

main_addressbooleanOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post/partners/{partner_id}/address

HTTPcURLJavaScriptPython

POST /api/sales/partners/{partner_id}/address HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 300

{
  "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,
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "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,
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Update an existing partner address

put

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

partner_idstringObrigatório

Corpo

application/json

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

idstringOpcional

partner_idstringOpcional

namestringOpcional

address_typestringOpcional

streetstringOpcional

numberstringOpcional

complementstringOpcional

contact_numberstringOpcional

contact_namestringOpcional

neighborhoodstringOpcional

statestringOpcional

countrystringOpcional

citystringOpcional

postal_codestringOpcional

main_addressbooleanOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put/partners/{partner_id}/address

HTTPcURLJavaScriptPython

PUT /api/sales/partners/{partner_id}/address HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 300

{
  "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,
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "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,
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Retrieve a PartnerAddress given an ID

get

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

partner_idstringObrigatório

idstringObrigatório

Respostas

200

OK

application/json

idstringOpcional

partner_idstringOpcional

namestringOpcional

address_typestringOpcional

streetstringOpcional

numberstringOpcional

complementstringOpcional

contact_numberstringOpcional

contact_namestringOpcional

neighborhoodstringOpcional

statestringOpcional

countrystringOpcional

citystringOpcional

postal_codestringOpcional

main_addressbooleanOpcional

404

PartnerAddress was not found

application/json

500

An internal server error was thrown

application/json

get/partners/{partner_id}/address/{id}

HTTPcURLJavaScriptPython

GET /api/sales/partners/{partner_id}/address/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
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,
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Remove a PartnerAddress given an ID

delete

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

partner_idstringObrigatório

idstringObrigatório

Respostas

204

Partner removed successfully

Sem conteúdo

422

A validation error was thrown

500

An internal server error was thrown

delete/partners/{partner_id}/address/{id}

HTTPcURLJavaScriptPython

DELETE /api/sales/partners/{partner_id}/address/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Sem conteúdo