Partners

Get partner

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

Authorization

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

Path parameters

id*string

Query parameters

Response

200404500

OK

Body

application/json

idstring

namestring

typestring

fiscal_registration_numberstring

state_registrationstring

emailstring

phonestring

mobilestring

profile_idstring

seller_idstring

activeboolean

attributesobject

additional_dataobject

addressesarray of PartnerAddressResponse (object)

payment_methodsarray of PartnerPaymentMethodsResponse (object)

sellersarray of PartnerSellersResponse (object)

Request

JavaScriptCurlPython

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

Response

200404500

{
  "id": "text",
  "name": "text",
  "type": "text",
  "fiscal_registration_number": "text",
  "state_registration": "text",
  "email": "text",
  "phone": "text",
  "mobile": "text",
  "profile_id": "text",
  "seller_id": "text",
  "active": false,
  "addresses": [
    {
      "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
    }
  ],
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text",
      "name": "text",
      "min_value": 0,
      "max_value": 0
    }
  ],
  "sellers": [
    {
      "id": "text",
      "seller_id": "text",
      "name": "text",
      "main": false
    }
  ]
}

Update partner

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

Authorization

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

Path parameters

id*string

Body

application/json

name*string

type*string

fiscal_registration_number*string

state_registration*string

email*string

phone*string

mobile*string

profile_idstring

seller_id*string

active*boolean

status*string

attributesobject

additional_dataobject

addressesarray of UpdatePartnerAddressRequest (object)

payment_methodsarray of UpdatePartnerPaymentMethodRequest (object)

sellersarray of string

Response

200422500

Partner updated successfully

Body

application/json

idstring

namestring

typestring

fiscal_registration_numberstring

state_registrationstring

emailstring

phonestring

mobilestring

profile_idstring

seller_idstring

activeboolean

attributesobject

additional_dataobject

addressesarray of PartnerAddressResponse (object)

payment_methodsarray of UpdatePartnerPaymentMethodsResponse (object)

sellersarray of UpdatePartnerSellersResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/partners/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "active": false,
      "email": "text",
      "fiscal_registration_number": "text",
      "mobile": "text",
      "name": "text",
      "phone": "text",
      "seller_id": "text",
      "state_registration": "text",
      "status": "text",
      "type": "text"
    }),
});
const data = await response.json();

Response

200422500

{
  "id": "text",
  "name": "text",
  "type": "text",
  "fiscal_registration_number": "text",
  "state_registration": "text",
  "email": "text",
  "phone": "text",
  "mobile": "text",
  "profile_id": "text",
  "seller_id": "text",
  "active": false,
  "addresses": [
    {
      "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
    }
  ],
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text",
      "name": "text",
      "payment_method_type": "text",
      "min_value": 0,
      "max_value": 0
    }
  ],
  "sellers": [
    {
      "id": "text",
      "seller_id": "text",
      "name": "text"
    }
  ]
}

Remove Partner

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

Authorization

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

Path parameters

id*string

Response

204422500

Partner removed successfully

Body

application/json

idstring

Request

JavaScriptCurlPython

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

Response

204422500

{
  "id": "text"
}

List partners

GEThttps://api.zydon.com.br/api/sales/partners

Authorization

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

Query parameters

Response

200404500

OK

Body

application/json

currentPageinteger (int32)

perPageinteger (int32)

totalinteger (int64)

itemsarray of ListPartnerResponse (object)

Request

JavaScriptCurlPython

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

Response

200404500

{
  "currentPage": 0,
  "perPage": 0,
  "total": 0,
  "items": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "fiscal_registration_number": "text",
      "state_registration": "text",
      "email": "text",
      "phone": "text",
      "mobile": "text",
      "profile_id": "text",
      "seller_id": "text",
      "active": false
    }
  ]
}

Create partner

POSThttps://api.zydon.com.br/api/sales/partners

Authorization

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

Body

application/json

idstring

name*string

type*string

fiscal_registration_number*string

state_registration*string

email*string

phone*string

mobile*string

profile_idstring

seller_id*string

active*boolean

status*string

attributesobject

additional_dataobject

addressesarray of CreatePartnerAddressRequest (object)

payment_methodsarray of CreatePartnerPaymentMethodRequest (object)

sellersarray of string

Response

201422500

Partner created successfully

Body

application/json

idstring

namestring

typestring

fiscal_registration_numberstring

state_registrationstring

emailstring

phonestring

mobilestring

profile_idstring

seller_idstring

activeboolean

attributesobject

additional_dataobject

addressesarray of PartnerAddressResponse (object)

payment_methodsarray of CreatePartnerPaymentMethodsResponse (object)

sellersarray of CreatePartnerSellersResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/partners', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "active": false,
      "email": "text",
      "fiscal_registration_number": "text",
      "mobile": "text",
      "name": "text",
      "phone": "text",
      "seller_id": "text",
      "state_registration": "text",
      "status": "text",
      "type": "text"
    }),
});
const data = await response.json();

Response

201422500

{
  "id": "text",
  "name": "text",
  "type": "text",
  "fiscal_registration_number": "text",
  "state_registration": "text",
  "email": "text",
  "phone": "text",
  "mobile": "text",
  "profile_id": "text",
  "seller_id": "text",
  "active": false,
  "addresses": [
    {
      "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
    }
  ],
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text",
      "name": "text",
      "payment_method_type": "text",
      "min_value": 0,
      "max_value": 0
    }
  ],
  "sellers": [
    {
      "id": "text",
      "seller_id": "text",
      "name": "text"
    }
  ]
}