Query

Query partners

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 consulta

searchstringOpcionalDefault: ""

pageinteger · int32OpcionalDefault: 0

perPageinteger · int32OpcionalDefault: 25

sortstringOpcionalDefault: ""

dirstringOpcionalDefault: asc

only_activebooleanOpcional

sellerIdstringOpcionalDefault: ""

fiscal_registration_numberstringOpcional

Corpo

application/json

partner_idsstring[]Opcional

filterstringOpcional

criteriastring[]Opcional

Respostas

200

OK

application/json

404

Partner was not found

application/json

500

An internal server error was thrown

application/json

post

/partners/query

HTTPcURLJavaScriptPython

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

{
  "partner_ids": [
    "text"
  ],
  "filter": "text",
  "criteria": [
    "text"
  ],
  "arguments": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

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