> ## Documentation Index > Fetch the complete documentation index at: https://pedirgasdocs.supergasbras.app/llms.txt > Use this file to discover all available pages before exploring further. # Pesquisa por revendas utilizando filtros ## OpenAPI ````yaml https://dealer-ms.supergasbras.app/swagger/v1/swagger.json get /v1/dealers/search openapi: 3.0.4 info: title: Dealer description: A API Dealer é responsável pelo gerenciamento das revendas. version: v1 x-logo: url: |- data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQQAAACaBAMAAAC9PSu+AAAACX BIWXMAAA7DAAAOwwHHb6hkAAAAG1BMVEUAAADTMADTMQDTMgDTMQAAAAAAAAAAAAAAAABolM biAAAACXRSTlMAQL+A/0CAv/9sbqsWAAAFqklEQVR4nO2ZvXajOhDHhW2wyyTHD5BNeIB7Nj zAbswDuLHjkiaY0k0MZZoYHvtqPjQI7LvNngy30L+IQUijHzOjkRwbExQUFBQUFBQUFBQUFB QUNJWih2djfr7cTUfwkOcbY7I8/zEZwtoh/J5m/miI8M8EBOkQYaOPkOVDhFydYZ6PEXLtUK TXCK+6BHbyK4T8lypCegtB1Q2z/BZC/qiIkN1GUHTDnOfzESA0ud5msWCvZx4CxkavUGfsdE GAm1QzEnN2AnwSApSlmWYkeD1gcdjQB0QgVVwTGU0dcfTX/PprxWRgz+PUvzg5OSG1koHjAB +Agqlh3RBxu4I4C3Fm3KFTTs9ULR9n/UKgDXruJcWjCsJC6pI7pnCdmKntlmt8+7k4gd1whx 86SyITBDmrUUmIVBFGXl/TjdqqTHGiRe6dFme52y01EdY+QqSMQO7O/DrECIM2ZQTTlwpFhP X/A0GqcZ8LkyHMJ1kRC39DmFNd0ESw7z8oTQspTTpfbjPZEDZ+06hmf6vWsiEMtimjuE0tJP D+Zr2RBwqaeadWdMND3h+lH1UQIlqVdGR8uYse3CEyy7X+zxHxoT339SoZoSI6oFAknH7LmV JF/C0q8hHuBofJb5f79ui54dFQYLT+5eW+ydE5njOBwNT+65ayGxzD650Z1AkFQQ2iIvQTrp 6BYCZtKprLq5vo/p627FQ1DhyAzZ9bvlnodX/GB1kXakqpOg8JdP8DTG7INxj8+6dc3wl9SX h6ek694qCpeX4l9d9lsjHBBL9PjRgm+GFoxPA6yW+V82xqAqsXRzDdT6UmerEl4enHhD8YBw UFBQUF6Sg+nt/hoyzhbl9u4bK0H1Y7Eje9uyG7Y1nw5d5dsRkaYuRq68awRZzIDWYlndUFP+ G26Qqz7LjNdKQv6tV1NPYNLksaXtmHaLihIXHfka64n7377Ocrja+Gh1whgJkxAnbpH6Plll FAHw6h28pg6hfTO/XzjZwAj68RLjcQTmKELCY0m3veCsJJBtPMS+ZP/EbSyqKXzdgLbV2j7a 47QxLg0xravtBIez7yi6wYa0lmToBQlhV25CGIaA786is7uBx64YB5MM4Fui+M9E3Q3xX8rb AxuYj/P9EyDGnR4c4q9WOEhhEq6J74TrCdPyUiAwQD7zRCWMJf9uKWI3vE2xVnJSMsBQHNYD NO3s/nB6ItbiPAkBEC9Il9L9qbmOH6tHNO8REsPFk9DNIAtXRL5AbCyeWCj8D9HNnFoKcTZw YQdruG0rFgg+ilhOG69n1AQBl8Ka4RYsoFynNGOMjK4WZ420aWCZgBBJsg7bbPhYL9j1fxeD 0YrjPX6WhfZIywP0JHzAeHAME6YBpQhds6BKprRXJsnNkTZSIVkBHDkZbxCIGmGCBQUi99L1 ADFqeSCggj0KIsVjxdDNFa0cyVqy+ekgb6UR6xUURAK2faGxhBvOWVMx5okopLk903KmhjhK 3hpZTwy+/J9lAVjd2i7S0jSDgp7wDBOlpWBOeFq8b8fg6owboGCFKYuk4SueKqPsxJRkgcQn 3emiuElvz0RWa+sDZ6bgUTcR97QijE+VScxCm9moKdi5Yw0ktJlwHCkuaq0D+Y6c7yl5jpEb C0us2JtxWbj3FbmOHCBqBy13DhfbdXlyHCB236uChxkcCrX6Bjx7tA3RBeuTuQM+2AN1fdD2 4Hp44XiB/P0jtBdq6VAx0g8FsiwhJ97vZC2VzB/5Vrc08pF/DWLWTsL4N79WeR/rDxXwjAe5 LAFm6VQQgTlxQ9IEUR3UClA4P3JrP0qniJc5H6MH9ASFw2UEd3YoKaU7IZRuiXUyUFlDKkGj vBal/XH3RV1jWW70ROiSXJOpSa9jVYjY8ddtzzcRDPj2AG1iwEvcYHdFpMjmfjTovYsWzaDx MUFBQUFBQUFBQUFBQUFPT3+hdhiavi0aIAlwAAAABJRU5ErkJggg== altText: Logo servers: [] security: - Bearer: [] tags: - name: Agreements description: Acordos legais - name: Dealers description: Revendedores - name: Users description: Usuários paths: /v1/dealers/search: get: tags: - Dealers summary: Pesquisa por revendas utilizando filtros parameters: - name: limit in: query description: Número de registros a serem retornados schema: type: integer format: int64 - name: offset in: query description: Numero do começo de registros a serem retornados schema: type: integer format: int64 - name: term in: query description: Termo da pesquisa schema: type: string example: Acme example: Acme - name: addressState in: query description: Filtro por estado schema: type: string - name: addressCities in: query description: Cidades a serem pesquisadas schema: type: array items: type: string - name: units in: query description: Unidades a serem pesquisadas schema: type: array items: type: string - name: identifiers in: query description: Identificadores dos dealers a serem pesquisados schema: type: array items: type: string format: uuid example: - cbe566b9-035a-41f7-b000-10fc87c46e1a example: - cbe566b9-035a-41f7-b000-10fc87c46e1a - name: api-version in: query schema: type: string responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/DealerDtoIPaginatedDataResponse' application/json: schema: $ref: '#/components/schemas/DealerDtoIPaginatedDataResponse' text/json: schema: $ref: '#/components/schemas/DealerDtoIPaginatedDataResponse' components: schemas: DealerDtoIPaginatedDataResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/DealerDto' nullable: true readOnly: true pagination: $ref: '#/components/schemas/IPaginationData' additionalProperties: false DealerDto: required: - id type: object properties: taxpayerId: type: string nullable: true legalName: type: string nullable: true tradeName: type: string nullable: true email: type: string nullable: true telephone: $ref: '#/components/schemas/PhoneDto' cellphone: $ref: '#/components/schemas/PhoneDto' address: $ref: '#/components/schemas/AddressDto' external: $ref: '#/components/schemas/ExternalDto' enabled: type: boolean unit: type: string nullable: true subunit: type: string nullable: true whatsAppNumber: type: string nullable: true getnet: $ref: '#/components/schemas/GetnetDto' termsOfService: $ref: '#/components/schemas/LegalDocumentDto' parent: $ref: '#/components/schemas/ParentDealerDto' attributes: type: object additionalProperties: nullable: true description: Atributos customizados de chave e valor nullable: true example: externalId: '123456' id: type: string description: Identificador do registro format: uuid createdAt: type: string format: date-time modifiedAt: type: string format: date-time nullable: true additionalProperties: false IPaginationData: type: object properties: limit: type: integer format: int64 offset: type: integer format: int64 keyset: type: string nullable: true count: type: integer format: int64 totalCount: type: integer format: int64 additionalProperties: false PhoneDto: type: object properties: number: type: string nullable: true areaCode: type: string nullable: true countryCode: type: string nullable: true additionalProperties: false AddressDto: type: object properties: street: type: string nullable: true number: type: string nullable: true apartment: type: string nullable: true neighborhood: type: string nullable: true city: type: string nullable: true state: type: string nullable: true country: type: string nullable: true postalCode: type: string nullable: true latitude: type: string nullable: true longitude: type: string nullable: true timezone: type: string nullable: true additionalProperties: false ExternalDto: type: object properties: id: type: string nullable: true additionalProperties: false GetnetDto: type: object properties: sellerId: type: string description: Id do Seller format: uuid nullable: true example: beccc598-d4fc-485c-bec8-e9927fd1e6d2 clientId: type: string description: Id do Client format: uuid nullable: true example: beccc598-d4fc-485c-bec8-e9927fd1e6d2 clientSecret: type: string description: Secret do Client nullable: true example: beccc598-d4fc-485c-bec8-e9927fd1e6d2 ecHti: type: string description: Número ECHTI nullable: true example: '52124260' additionalProperties: false LegalDocumentDto: type: object properties: agreement: $ref: '#/components/schemas/AgreementSummaryDto' acceptedBy: $ref: '#/components/schemas/UserSummaryDto' acceptedAt: type: string format: date-time nullable: true disabledAt: type: string format: date-time nullable: true additionalProperties: false ParentDealerDto: type: object properties: id: type: string format: uuid taxpayerId: type: string nullable: true external: $ref: '#/components/schemas/ExternalDto' additionalProperties: false AgreementSummaryDto: required: - id type: object properties: type: type: string nullable: true version: type: string nullable: true effectiveAt: type: string format: date-time acceptUntil: type: string format: date-time nullable: true disableAt: type: string format: date-time nullable: true id: type: string description: Identificador do registro format: uuid createdAt: type: string format: date-time modifiedAt: type: string format: date-time nullable: true additionalProperties: false UserSummaryDto: required: - id type: object properties: name: type: string nullable: true profile: type: string nullable: true id: type: string description: Identificador do registro format: uuid createdAt: type: string format: date-time modifiedAt: type: string format: date-time nullable: true additionalProperties: false securitySchemes: Bearer: type: http description: Token de acesso `accessToken` obtido do serviço de autenticação. scheme: Bearer bearerFormat: JWT ````