Address

List all addresses given an partner ID

GEThttps://api.zydon.com.br/api/sales/partners/{partner_id}/address

Authorization

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

Path parameters

partner_id*string

Query parameters

Response

200404500

OK

Body

application/json

currentPageinteger (int32)

perPageinteger (int32)

totalinteger (int64)

itemsarray of PartnerAddressResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/partners/{partner_id}/address', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404500

{
  "currentPage": 0,
  "perPage": 0,
  "total": 0,
  "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": false
    }
  ]
}

Create a new partner address

POSThttps://api.zydon.com.br/api/sales/partners/{partner_id}/address

Authorization

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

Path parameters

partner_id*string

Body

application/json

idstring

namestring

address_typestring

streetstring

numberstring

complementstring

contact_numberstring

contact_namestring

neighborhoodstring

statestring

countrystring

citystring

postal_codestring

main_addressboolean

Response

201422500

PartnerAddress created successfully

Body

application/json

idstring

partner_idstring

namestring

address_typestring

streetstring

numberstring

complementstring

contact_numberstring

contact_namestring

neighborhoodstring

statestring

countrystring

citystring

postal_codestring

main_addressboolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/partners/{partner_id}/address', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201422500

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

Update an existing partner address

PUThttps://api.zydon.com.br/api/sales/partners/{partner_id}/address

Authorization

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

Path parameters

partner_id*string

Body

application/json

idstring

namestring

address_typestring

streetstring

numberstring

complementstring

contact_numberstring

contact_namestring

neighborhoodstring

statestring

countrystring

citystring

postal_codestring

main_addressboolean

Response

200422500

PartnerAddress updated successfully

Body

application/json

idstring

partner_idstring

namestring

address_typestring

streetstring

numberstring

complementstring

contact_numberstring

contact_namestring

neighborhoodstring

statestring

countrystring

citystring

postal_codestring

main_addressboolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/partners/{partner_id}/address', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200422500

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

Retrieve a PartnerAddress given an ID

GEThttps://api.zydon.com.br/api/sales/partners/{partner_id}/address/{id}

Authorization

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

Path parameters

partner_id*string

id*string

Response

200404500

OK

Body

application/json

idstring

partner_idstring

namestring

address_typestring

streetstring

numberstring

complementstring

contact_numberstring

contact_namestring

neighborhoodstring

statestring

countrystring

citystring

postal_codestring

main_addressboolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/partners/{partner_id}/address/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404500

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

Remove a PartnerAddress given an ID

DELETEhttps://api.zydon.com.br/api/sales/partners/{partner_id}/address/{id}

Authorization

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

Path parameters

partner_id*string

id*string

Response

204422500

Partner removed successfully

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/partners/{partner_id}/address/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();