Partners
Autorizações
Parâmetros de rota
idstringObrigatório
Parâmetros de consulta
summarybooleanOpcionalDefault:
false
Respostas
200
OK
application/json
404
Partner was not found
application/json
500
An internal server error was thrown
application/json
get
GET /api/sales/partners/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
"id": "text",
"name": "text",
"type": "text",
"fiscal_registration_number": "text",
"state_registration": "text",
"email": "text",
"phone": "text",
"mobile": "text",
"profile_id": "text",
"profile_name": "text",
"seller_id": "text",
"active": true,
"company_default": "text",
"attributes": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"additional_data": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"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": true
}
],
"sellers": [
{
"id": "text",
"seller_id": "text",
"name": "text",
"phone": "text",
"main": true
}
],
"contacts": [
{
"id": "text",
"partner_id": "text",
"name": "text",
"role": "text",
"phone": "text",
"email": "text",
"active": true
}
],
"payment_groups": [
{
"id": "text",
"payment_group_id": "text"
}
]
}
Autorizações
Parâmetros de rota
idstringObrigatório
Corpo
namestringObrigatório
typestringObrigatório
fiscal_registration_numberstringObrigatório
state_registrationstringObrigatório
emailstringObrigatório
phonestringObrigatório
mobilestringObrigatório
profile_idstringOpcional
seller_idstringObrigatório
activebooleanObrigatório
company_defaultstringOpcional
statusstringObrigatório
sellersstring[]Opcional
Respostas
200
Partner updated successfully
application/json
422
A validation error was thrown
application/json
500
An internal server error was thrown
application/json
put
PUT /api/sales/partners/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 774
{
"name": "text",
"type": "text",
"fiscal_registration_number": "text",
"state_registration": "text",
"email": "text",
"phone": "text",
"mobile": "text",
"profile_id": "text",
"seller_id": "text",
"active": true,
"company_default": "text",
"status": "text",
"attributes": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"additional_data": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"addresses": [
{
"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
}
],
"sellers": [
"text"
],
"contacts": [
{
"id": "text",
"name": "text",
"role": "text",
"phone": "text",
"email": "text",
"active": true
}
],
"payment_groups": [
{
"id": "text",
"payment_group_id": "text"
}
]
}
{
"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": true,
"company_default": "text",
"attributes": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"additional_data": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"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": true
}
],
"sellers": [
{
"id": "text",
"seller_id": "text",
"name": "text"
}
],
"contacts": [
{
"id": "text",
"partner_id": "text",
"name": "text",
"role": "text",
"phone": "text",
"email": "text",
"active": true
}
],
"payment_groups": [
{
"id": "text",
"payment_group_id": "text"
}
]
}
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
204
Partner removed successfully
application/json
422
A validation error was thrown
application/json
500
An internal server error was thrown
application/json
delete
DELETE /api/sales/partners/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
"id": "text"
}
Autorizações
Parâmetros de consulta
searchstringOpcionalDefault:
""
pageinteger · int32OpcionalDefault:
0
perPageinteger · int32OpcionalDefault:
25
sortstringOpcionalDefault:
""
dirstringOpcionalDefault:
asc
only_activebooleanOpcional
sellerIdstringOpcionalDefault:
""
fiscal_registration_numberstringOpcional
criteriastring[]Opcional
argumentsstringOpcional
partner_idsstring[]Opcional
Respostas
200
OK
application/json
404
Partner was not found
application/json
500
An internal server error was thrown
application/json
get
GET /api/sales/partners HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
"currentPage": 1,
"perPage": 1,
"total": 1,
"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": true,
"company_default": "text",
"attributes": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"additional_data": {
"ANY_ADDITIONAL_PROPERTY": {}
}
}
]
}
Autorizações
Corpo
idstringOpcional
namestringObrigatório
typestringObrigatório
fiscal_registration_numberstringObrigatório
state_registrationstringObrigatório
emailstringObrigatório
phonestringObrigatório
mobilestringObrigatório
profile_idstringOpcional
seller_idstringObrigatório
activebooleanObrigatório
company_defaultstringOpcional
statusstringObrigatório
sellersstring[]Opcional
Respostas
201
Partner created successfully
application/json
422
A validation error was thrown
application/json
500
An internal server error was thrown
application/json
post
POST /api/sales/partners HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 786
{
"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": true,
"company_default": "text",
"status": "text",
"attributes": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"additional_data": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"addresses": [
{
"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
}
],
"sellers": [
"text"
],
"contacts": [
{
"id": "text",
"name": "text",
"role": "text",
"phone": "text",
"email": "text",
"active": true
}
],
"payment_groups": [
{
"id": "text",
"payment_group_id": "text"
}
]
}
{
"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": true,
"company_default": "text",
"attributes": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"additional_data": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"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": true
}
],
"sellers": [
{
"id": "text",
"seller_id": "text",
"name": "text"
}
],
"contacts": [
{
"id": "text",
"partner_id": "text",
"name": "text",
"role": "text",
"phone": "text",
"email": "text",
"active": true
}
],
"payment_groups": [
{
"id": "text",
"payment_group_id": "text"
}
]
}