Partners

Get partner

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

idstringObrigatório

Parâmetros de consulta

summarybooleanOpcionalDefault: false

Respostas

200

OK

application/json

idstringOpcional

namestringOpcional

trade_namestringOpcional

typestringOpcional

fiscal_registration_numberstringOpcional

state_registrationstringOpcional

emailstringOpcional

phonestringOpcional

mobilestringOpcional

profile_idstringOpcional

profile_namestringOpcional

seller_idstringOpcional

activebooleanOpcional

company_defaultstringOpcional

credit_limitnumberOpcional

credit_limit_usednumberOpcional

monthly_credit_limitnumberOpcional

monthly_credit_limit_usednumberOpcional

404

Partner was not found

application/json

500

An internal server error was thrown

application/json

get/partners/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "name": "text",
  "trade_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": {}
  },
  "credit_limit": 1,
  "credit_limit_used": 1,
  "monthly_credit_limit": 1,
  "monthly_credit_limit_used": 1,
  "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,
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "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",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ]
}

Update partner

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

idstringObrigatório

Corpo

application/json

namestringObrigatório

trade_namestringOpcional

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

credit_limitnumberOpcional

monthly_credit_limitnumberOpcional

sellersstring[]Opcional

Respostas

200

Partner updated successfully

application/json

idstringOpcional

namestringOpcional

typestringOpcional

fiscal_registration_numberstringOpcional

state_registrationstringOpcional

emailstringOpcional

phonestringOpcional

mobilestringOpcional

profile_idstringOpcional

seller_idstringOpcional

activebooleanOpcional

company_defaultstringOpcional

credit_limitnumberOpcional

credit_limit_usednumberOpcional

monthly_credit_limitnumberOpcional

monthly_credit_limit_usednumberOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put/partners/{id}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "trade_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": {}
  },
  "credit_limit": 1,
  "monthly_credit_limit": 1,
  "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,
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "sellers": [
    "text"
  ],
  "contacts": [
    {
      "id": "text",
      "name": "text",
      "role": "text",
      "phone": "text",
      "email": "text",
      "active": true,
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "payment_groups": [
    {
      "id": "text",
      "payment_group_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ]
}

{
  "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": {}
  },
  "credit_limit": 1,
  "credit_limit_used": 1,
  "monthly_credit_limit": 1,
  "monthly_credit_limit_used": 1,
  "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,
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "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",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ]
}

Remove Partner

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

idstringObrigatório

Respostas

204

Partner removed successfully

application/json

idstringOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

delete/partners/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "text"
}

List partners

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 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

currentPageinteger · int32Opcional

perPageinteger · int32Opcional

totalinteger · int64Opcional

404

Partner was not found

application/json

500

An internal server error was thrown

application/json

get/partners

HTTPcURLJavaScriptPython

GET /api/sales/partners HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
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": {}
      },
      "credit_limit": 1,
      "credit_limit_used": 1,
      "monthly_credit_limit": 1,
      "monthly_credit_limit_used": 1
    }
  ]
}

Create partner

post

Autorizações

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

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

idstringOpcional

namestringObrigatório

trade_namestringOpcional

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

credit_limitnumberOpcional

monthly_credit_limitnumberOpcional

sellersstring[]Opcional

webhook_idstringOpcional

webhook_request_idstringOpcional

Respostas

201

Partner created successfully

application/json

idstringOpcional

namestringOpcional

typestringOpcional

fiscal_registration_numberstringOpcional

state_registrationstringOpcional

emailstringOpcional

phonestringOpcional

mobilestringOpcional

profile_idstringOpcional

seller_idstringOpcional

activebooleanOpcional

company_defaultstringOpcional

credit_limitnumberOpcional

credit_limit_usednumberOpcional

monthly_credit_limitnumberOpcional

monthly_credit_limit_usednumberOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post/partners

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "name": "text",
  "trade_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": {}
  },
  "credit_limit": 1,
  "monthly_credit_limit": 1,
  "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,
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "sellers": [
    "text"
  ],
  "contacts": [
    {
      "id": "text",
      "name": "text",
      "role": "text",
      "phone": "text",
      "email": "text",
      "active": true
    }
  ],
  "payment_groups": [
    {
      "id": "text",
      "payment_group_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "webhook_id": "text",
  "webhook_request_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": {}
  },
  "credit_limit": 1,
  "credit_limit_used": 1,
  "monthly_credit_limit": 1,
  "monthly_credit_limit_used": 1,
  "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,
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "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",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ]
}