A pesquisa retorna registros nos quais o código do produto ou parte deste código é igual ao passado no parâmetro.
Exemplo: Para a pesquisa retornar registros com o código 12345, pode-se passar tanto o parâmetro 12345, quanto os parâmetros 1, 2, 3, 4, 5, 12, 23, 123, 345…
A pesquisa retorna registros nos quais o nome do produto ou parte deste nome é igual ao passado no parâmetro.
Exemplo: Para a pesquisa retornar registros com o nome ABCDE, pode-se passar tanto o parâmetro ABCDE, quanto os parâmetros A, B, C, D, E, AB, BC, ABC, CDE…
A pesquisa retorna registros nos quais o nome do fabricante do produto ou parte deste nome é igual ao passado no parâmetro.
Exemplo: Para a pesquisa retornar registros com o nome ABCDE, pode-se passar tanto o parâmetro ABCDE, quanto os parâmetros A, B, C, D, E, AB, BC, ABC, CDE…
A pesquisa retorna registros nos quais o nome do modelo do produto ou parte deste nome é igual ao passado no parâmetro.
Exemplo: Para a pesquisa retornar registros com o nome ABCDE, pode-se passar tanto o parâmetro ABCDE, quanto os parâmetros A, B, C, D, E, AB, BC, ABC, CDE…
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"PIED API","colors":{"primary":"#7A2BEF","light":"#8800FF","dark":"#7A2BEF"},"logo":{"light":"https://mintcdn.com/pied-3a231858/srnY5TMUiKfzvm-Y/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=srnY5TMUiKfzvm-Y\u0026q=85\u0026s=bf6f5b58ad371d63853387ff87e07cc6","dark":"https://mintcdn.com/pied-3a231858/srnY5TMUiKfzvm-Y/logo/logo-dark.svg?fit=max\u0026auto=format\u0026n=srnY5TMUiKfzvm-Y\u0026q=85\u0026s=0f7090387596567ccfd597f59121812b","href":"https://docs.pied.com.br/docs/introduction"},"favicon":"https://mintcdn.com/pied-3a231858/srnY5TMUiKfzvm-Y/icone.svg?fit=max\u0026auto=format\u0026n=srnY5TMUiKfzvm-Y\u0026q=85\u0026s=53cc079759c2963208ea63d872b3c2c2","api":{"mdx":{"auth":{"method":"bearer"}}},"navbar":{"primary":{"type":"button","label":"Central de ajuda","href":"https://suportepied.tawk.help/"}},"footer":{"socials":{"website":"https://pied.com.br","linkedin":"https://www.linkedin.com/company/pietatech?originalSubdomain=br","instagram":"https://www.instagram.com/pieta.tech"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Nosso site","icon":"earth-americas","href":"https://pied.com.br"},{"anchor":"Central de ajuda","icon":"circle-question","href":"https://suportepied.tawk.help/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pied-3a231858","hasAudioNarration":false,"actualSubdomain":"pied-3a231858","customDomains":["docs.pied.com.br"],"gitSource":{"type":"github","owner":"pied-software","repo":"pied-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad22ad995906ab85f64eee1","collectionId":"fb243472-6c68-44d3-892f-f1b693dec311","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad22ad995906ab85f64eee1"},"entitlements":{},"buildId":"6ad22ad995906ab85f64eee1","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":35},{"language":"default","tag":"Comentários","count":7},{"language":"default","tag":"Requests","count":6},{"language":"default","tag":"Tarefas","count":5},{"language":"default","tag":"Integrações","count":5},{"language":"default","tag":"Pagamentos","count":4},{"language":"default","tag":"Empresas","count":3},{"language":"default","tag":"Equipamentos","count":3},{"language":"default","tag":"Plataformas de Automação","count":3},{"language":"default","tag":"Colaboradores","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/v2/equipment/get-equipments","slug":"/api-reference/v2/equipment/get-equipments","pageMetadata":{"title":"Retorna informações sobre os equipamentos","openapi":"openapi/openapi-v2.json GET /equipments/{pageNumber}/{pageLimit}","description":"Para uma resposta válida utilize o pageLimit corretamente. De outra forma irá retornar uma exceção.","href":"/api-reference/v2/equipment/get-equipments"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Para uma resposta válida utilize o pageLimit corretamente. De outra forma irá retornar uma exceção.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`🚀 API v2 (Recomendada)`}),` - Use este endpoint para novos projetos`]})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Retorna informações sobre os equipamentos","openapi":"openapi/openapi-v2.json GET /equipments/{pageNumber}/{pageLimit}","description":"Para uma resposta válida utilize o pageLimit corretamente. De outra forma irá retornar uma exceção.","href":"/api-reference/v2/equipment/get-equipments"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"security":["f3945066-97c9-4db5-9517-db2e47bb3d96"],"tags":["Equipment"],"summary":"Essa rota irá retornar informações sobre os equipamentos.","description":"Para uma resposta válida utilize o pageLimit corretamente. De outra forma irá retornar uma exceção.","parameters":["ecec4e3b-a7cc-4ff3-9afe-f2985c4cf06e","48e3d942-2b9b-464f-8f5f-05d0b07bb1e4","5e99850a-f738-4da7-94a5-f61d335f3a52","1b84b180-9bc4-4f01-b7cb-2fb3c2420034","2dc4c833-7648-4156-a02b-02c77822c8e0","2bb4ce85-3c1a-490f-9a6d-1af2a9b46f54","5ac7e4e4-fe4f-4ea1-b7dd-a953a60e3b06","9f9ecc31-af86-4902-935f-152e12f06aca","68c8f84b-945c-43ac-bb95-f44ddf4b5aac","d375ceee-e053-463b-9a9b-8fbd71ab68ac","1761af6d-3b83-4187-8a11-ffd27e767e22"],"responses":{"200":"3c113f48-135d-4125-a890-18494ed33d1d","401":"9169391e-9e07-4022-a280-f12649031373","404":"da5a0867-082c-4ce9-81f3-f0301a3a6123","429":"fe9df1ba-6aef-46ef-a502-b01d50e3366d","500":"7b6e27b5-d39f-443b-94d8-802512c9f1e6"},"method":"get","type":"path","servers":["3fac26e0-8dcf-42c3-945a-4c630c695244"],"path":"/equipments/{pageNumber}/{pageLimit}","baseUrlOptions":["https://backend-pied-prod.piedadmin.com.br/api/v2"],"title":"Essa rota irá retornar informações sobre os equipamentos.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ecec4e3b-a7cc-4ff3-9afe-f2985c4cf06e":{"name":"pageNumber","in":"path","description":"Determina o número da página a ser retornada.","required":true,"schema":{"type":"integer","isRequired":true,"description":"Determina o número da página a ser retornada.","uniqueKey":"","typeLabel":"integer"}},"48e3d942-2b9b-464f-8f5f-05d0b07bb1e4":{"name":"pageLimit","in":"path","description":"Limita a quantidade de registros retornados por página.","required":true,"schema":{"type":"integer","isRequired":true,"description":"Limita a quantidade de registros retornados por página.","uniqueKey":"","typeLabel":"integer"}},"5e99850a-f738-4da7-94a5-f61d335f3a52":{"name":"createdBefore","in":"query","description":"A pesquisa retorna registros criados até esta data passada no parâmetro. Formato (AAAA-MM-DD).","schema":{"type":"string","description":"A pesquisa retorna registros criados até esta data passada no parâmetro. Formato (AAAA-MM-DD).","uniqueKey":"","typeLabel":"string"}},"1b84b180-9bc4-4f01-b7cb-2fb3c2420034":{"name":"createdAfter","in":"query","description":"A pesquisa retorna registros criados a partir desta data passada no parâmetro. Formato (AAAA-MM-DD).","schema":{"type":"string","description":"A pesquisa retorna registros criados a partir desta data passada no parâmetro. Formato (AAAA-MM-DD).","uniqueKey":"","typeLabel":"string"}},"2dc4c833-7648-4156-a02b-02c77822c8e0":{"name":"type","in":"query","description":"A pesquisa retorna registros nos quais o tipo do produto é igual ao passado no parâmetro.","schema":{"type":"string","enum":["module","inverter","stringBox","complementaryEquipment"],"description":"A pesquisa retorna registros nos quais o tipo do produto é igual ao passado no parâmetro.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"2bb4ce85-3c1a-490f-9a6d-1af2a9b46f54":{"name":"productCode","in":"query","description":"A pesquisa retorna registros nos quais o código do produto ou parte deste código é igual ao passado no parâmetro. \n \n Exemplo: Para a pesquisa retornar registros com o código 12345, pode-se passar tanto o parâmetro 12345, quanto os parâmetros 1, 2, 3, 4, 5, 12, 23, 123, 345…","schema":{"type":"string","description":"A pesquisa retorna registros nos quais o código do produto ou parte deste código é igual ao passado no parâmetro. \n \n Exemplo: Para a pesquisa retornar registros com o código 12345, pode-se passar tanto o parâmetro 12345, quanto os parâmetros 1, 2, 3, 4, 5, 12, 23, 123, 345…","uniqueKey":"","typeLabel":"string"}},"5ac7e4e4-fe4f-4ea1-b7dd-a953a60e3b06":{"name":"name","in":"query","description":"A pesquisa retorna registros nos quais o nome do produto ou parte deste nome é igual ao passado no parâmetro. \n \n Exemplo: Para a pesquisa retornar registros com o nome ABCDE, pode-se passar tanto o parâmetro ABCDE, quanto os parâmetros A, B, C, D, E, AB, BC, ABC, CDE…","schema":{"type":"string","description":"A pesquisa retorna registros nos quais o nome do produto ou parte deste nome é igual ao passado no parâmetro. \n \n Exemplo: Para a pesquisa retornar registros com o nome ABCDE, pode-se passar tanto o parâmetro ABCDE, quanto os parâmetros A, B, C, D, E, AB, BC, ABC, CDE…","uniqueKey":"","typeLabel":"string"}},"9f9ecc31-af86-4902-935f-152e12f06aca":{"name":"manufacturer","in":"query","description":"A pesquisa retorna registros nos quais o nome do fabricante do produto ou parte deste nome é igual ao passado no parâmetro.\n \n Exemplo: Para a pesquisa retornar registros com o nome ABCDE, pode-se passar tanto o parâmetro ABCDE, quanto os parâmetros A, B, C, D, E, AB, BC, ABC, CDE…","schema":{"type":"string","description":"A pesquisa retorna registros nos quais o nome do fabricante do produto ou parte deste nome é igual ao passado no parâmetro.\n \n Exemplo: Para a pesquisa retornar registros com o nome ABCDE, pode-se passar tanto o parâmetro ABCDE, quanto os parâmetros A, B, C, D, E, AB, BC, ABC, CDE…","uniqueKey":"","typeLabel":"string"}},"68c8f84b-945c-43ac-bb95-f44ddf4b5aac":{"name":"model","in":"query","description":"A pesquisa retorna registros nos quais o nome do modelo do produto ou parte deste nome é igual ao passado no parâmetro.\n \n Exemplo: Para a pesquisa retornar registros com o nome ABCDE, pode-se passar tanto o parâmetro ABCDE, quanto os parâmetros A, B, C, D, E, AB, BC, ABC, CDE…","schema":{"type":"string","description":"A pesquisa retorna registros nos quais o nome do modelo do produto ou parte deste nome é igual ao passado no parâmetro.\n \n Exemplo: Para a pesquisa retornar registros com o nome ABCDE, pode-se passar tanto o parâmetro ABCDE, quanto os parâmetros A, B, C, D, E, AB, BC, ABC, CDE…","uniqueKey":"","typeLabel":"string"}},"d375ceee-e053-463b-9a9b-8fbd71ab68ac":{"name":"basePriceGTE","in":"query","description":"A pesquisa retorna registros criados com preço base de valor superior ou igual ao passado no parâmetro.","schema":{"type":"number","description":"A pesquisa retorna registros criados com preço base de valor superior ou igual ao passado no parâmetro.","uniqueKey":"","typeLabel":"number"}},"1761af6d-3b83-4187-8a11-ffd27e767e22":{"name":"basePriceLTE","in":"query","description":"A pesquisa retorna registros criados com preço base de valor inferior ou igual ao passado no parâmetro.","schema":{"type":"number","description":"A pesquisa retorna registros criados com preço base de valor inferior ou igual ao passado no parâmetro.","uniqueKey":"","typeLabel":"number"}}},"responses":{"3c113f48-135d-4125-a890-18494ed33d1d":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","example":"module / inverter / stringBox / complementaryEquipment","uniqueKey":"type","typeLabel":"string"},"productCode":{"type":"string","example":"codigo123","uniqueKey":"productCode","typeLabel":"string"},"name":{"type":"string","example":"Nome do produto ","uniqueKey":"name","typeLabel":"string"},"manufacturer":{"type":"string","example":"Nome do fabricante","uniqueKey":"manufacturer","typeLabel":"string"},"model":{"type":"string","example":"Modelo","uniqueKey":"model","typeLabel":"string"},"baseprice":{"type":"number","example":1000,"uniqueKey":"baseprice","typeLabel":"number"},"costPrice":{"type":"number","example":500,"uniqueKey":"costPrice","typeLabel":"number"},"nominalMaxPower":{"type":"number","example":500,"uniqueKey":"nominalMaxPower","typeLabel":"number"},"nominalOutputPower":{"type":"number","example":10,"uniqueKey":"nominalOutputPower","typeLabel":"number"},"height":{"type":"number","example":10,"uniqueKey":"height","typeLabel":"number"},"width":{"type":"number","example":10,"uniqueKey":"width","typeLabel":"number"},"lenght":{"type":"number","example":10,"uniqueKey":"lenght","typeLabel":"number"},"weight":{"type":"number","example":10,"uniqueKey":"weight","typeLabel":"number"},"volume":{"type":"number","example":10,"uniqueKey":"volume","typeLabel":"number"},"featured":{"type":"boolean","example":true,"uniqueKey":"featured","typeLabel":"boolean"},"featuredEcommerce":{"type":"boolean","example":true,"uniqueKey":"featuredEcommerce","typeLabel":"boolean"},"isToSell":{"type":"boolean","example":true,"uniqueKey":"isToSell","typeLabel":"boolean"},"isToSellIntegrator":{"type":"boolean","example":true,"uniqueKey":"isToSellIntegrator","typeLabel":"boolean"},"isToSellOptions":{"type":"object","properties":{"separatedSales":{"type":"boolean","example":true,"uniqueKey":"isToSellOptions.separatedSales","typeLabel":"boolean"},"closedKitSales":{"type":"boolean","example":true,"uniqueKey":"isToSellOptions.closedKitSales","typeLabel":"boolean"},"mountKitSales":{"type":"boolean","example":true,"uniqueKey":"isToSellOptions.mountKitSales","typeLabel":"boolean"}},"uniqueKey":"isToSellOptions","typeLabel":"object"},"storeSellOptions":{"type":"object","properties":{"separatedSales":{"type":"boolean","example":true,"uniqueKey":"storeSellOptions.separatedSales","typeLabel":"boolean"},"closedKitSales":{"type":"boolean","example":true,"uniqueKey":"storeSellOptions.closedKitSales","typeLabel":"boolean"}},"uniqueKey":"storeSellOptions","typeLabel":"object"},"ecommerceSellOptions":{"type":"object","properties":{"separatedSales":{"type":"boolean","example":true,"uniqueKey":"ecommerceSellOptions.separatedSales","typeLabel":"boolean"},"closedKitSales":{"type":"boolean","example":true,"uniqueKey":"ecommerceSellOptions.closedKitSales","typeLabel":"boolean"}},"uniqueKey":"ecommerceSellOptions","typeLabel":"object"},"inventory":{"type":"object","properties":{"current":{"type":"number","example":100,"uniqueKey":"inventory.current","typeLabel":"number"},"reserved":{"type":"number","example":50,"uniqueKey":"inventory.reserved","typeLabel":"number"},"minimum":{"type":"number","example":0,"uniqueKey":"inventory.minimum","typeLabel":"number"}},"uniqueKey":"inventory","typeLabel":"object"},"inventoryByCenter":{"type":"array","items":{"type":"object","properties":{"center":{"type":"string","example":"CD001","uniqueKey":"inventoryByCenter.items.[INDEX].center","typeLabel":"string"},"current":{"type":"number","example":100,"uniqueKey":"inventoryByCenter.items.[INDEX].current","typeLabel":"number"},"reserved":{"type":"number","example":50,"uniqueKey":"inventoryByCenter.items.[INDEX].reserved","typeLabel":"number"},"minimum":{"type":"number","example":0,"uniqueKey":"inventoryByCenter.items.[INDEX].minimum","typeLabel":"number"}},"uniqueKey":"inventoryByCenter.items.[INDEX]","typeLabel":"object"},"uniqueKey":"inventoryByCenter","typeLabel":"object[]"},"moduleSpecifications":{"type":"object","properties":{"ratedMaximumPower":{"type":"number","example":500,"uniqueKey":"moduleSpecifications.ratedMaximumPower","typeLabel":"number"},"efficiency":{"type":"number","example":10,"uniqueKey":"moduleSpecifications.efficiency","typeLabel":"number"},"openCircuitVoltage":{"type":"number","example":40.5,"uniqueKey":"moduleSpecifications.openCircuitVoltage","typeLabel":"number"},"shortCircuitCurrent":{"type":"number","example":9.5,"uniqueKey":"moduleSpecifications.shortCircuitCurrent","typeLabel":"number"},"maximumPowerVoltage":{"type":"number","example":33.5,"uniqueKey":"moduleSpecifications.maximumPowerVoltage","typeLabel":"number"},"maximumPowerCurrent":{"type":"number","example":8.5,"uniqueKey":"moduleSpecifications.maximumPowerCurrent","typeLabel":"number"},"cellType":{"type":"string","example":"mono","uniqueKey":"moduleSpecifications.cellType","typeLabel":"string"}},"uniqueKey":"moduleSpecifications","typeLabel":"object"},"inverterSpecifications":{"type":"object","properties":{"inverterType":{"type":"string","example":"Tipo de inversor","uniqueKey":"inverterSpecifications.inverterType","typeLabel":"string"},"connectionType":{"type":"string","example":"Tipo de ligação","uniqueKey":"inverterSpecifications.connectionType","typeLabel":"string"},"maximumInputPower":{"type":"number","example":10,"uniqueKey":"inverterSpecifications.maximumInputPower","typeLabel":"number"},"maximumInputPowerPerString":{"type":"number","example":500,"uniqueKey":"inverterSpecifications.maximumInputPowerPerString","typeLabel":"number"},"startVoltage":{"type":"number","example":100,"uniqueKey":"inverterSpecifications.startVoltage","typeLabel":"number"},"minimumMPPTVoltage":{"type":"number","example":150,"uniqueKey":"inverterSpecifications.minimumMPPTVoltage","typeLabel":"number"},"maximumMPPTVoltage":{"type":"number","example":1000,"uniqueKey":"inverterSpecifications.maximumMPPTVoltage","typeLabel":"number"},"mpptAmount":{"type":"number","example":2,"uniqueKey":"inverterSpecifications.mpptAmount","typeLabel":"number"},"ratedOutputPower":{"type":"number","example":10,"uniqueKey":"inverterSpecifications.ratedOutputPower","typeLabel":"number"},"ratedOutputVoltage":{"type":"number","example":400,"uniqueKey":"inverterSpecifications.ratedOutputVoltage","typeLabel":"number"},"maximumOutputCurrent":{"type":"number","example":50,"uniqueKey":"inverterSpecifications.maximumOutputCurrent","typeLabel":"number"},"maximumInputCurrentPerMPPT":{"type":"array","items":{"type":"number","example":20,"uniqueKey":"inverterSpecifications.maximumInputCurrentPerMPPT.items.[INDEX]","typeLabel":"number"},"uniqueKey":"inverterSpecifications.maximumInputCurrentPerMPPT","typeLabel":"number[]"},"maximumInputCurrent":{"type":"array","items":{"type":"number","example":40,"uniqueKey":"inverterSpecifications.maximumInputCurrent.items.[INDEX]","typeLabel":"number"},"uniqueKey":"inverterSpecifications.maximumInputCurrent","typeLabel":"number[]"},"stringsPerMPPT":{"type":"array","items":{"type":"number","example":20,"uniqueKey":"inverterSpecifications.stringsPerMPPT.items.[INDEX]","typeLabel":"number"},"uniqueKey":"inverterSpecifications.stringsPerMPPT","typeLabel":"number[]"},"maximumCurrentDCConnector":{"type":"array","items":{"type":"number","example":20,"uniqueKey":"inverterSpecifications.maximumCurrentDCConnector.items.[INDEX]","typeLabel":"number"},"uniqueKey":"inverterSpecifications.maximumCurrentDCConnector","typeLabel":"number[]"},"maximumCurrent":{"type":"array","items":{"type":"number","example":20,"uniqueKey":"inverterSpecifications.maximumCurrent.items.[INDEX]","typeLabel":"number"},"uniqueKey":"inverterSpecifications.maximumCurrent","typeLabel":"number[]"},"solarEdgeSpecifications":{"type":"object","properties":{"compatibleInverters":{"type":"array","items":{"type":"string","example":1,"uniqueKey":"inverterSpecifications.solarEdgeSpecifications.compatibleInverters.items.[INDEX]","typeLabel":"string"},"uniqueKey":"inverterSpecifications.solarEdgeSpecifications.compatibleInverters","typeLabel":"string[]"},"minimumStringLength":{"type":"array","items":{"type":"number","example":1,"uniqueKey":"inverterSpecifications.solarEdgeSpecifications.minimumStringLength.items.[INDEX]","typeLabel":"number"},"uniqueKey":"inverterSpecifications.solarEdgeSpecifications.minimumStringLength","typeLabel":"number[]"},"maximumStringLength":{"type":"array","items":{"type":"number","example":1,"uniqueKey":"inverterSpecifications.solarEdgeSpecifications.maximumStringLength.items.[INDEX]","typeLabel":"number"},"uniqueKey":"inverterSpecifications.solarEdgeSpecifications.maximumStringLength","typeLabel":"number[]"},"maximumContinuousPowerPerString":{"type":"array","items":{"type":"number","example":5000,"uniqueKey":"inverterSpecifications.solarEdgeSpecifications.maximumContinuousPowerPerString.items.[INDEX]","typeLabel":"number"},"uniqueKey":"inverterSpecifications.solarEdgeSpecifications.maximumContinuousPowerPerString","typeLabel":"number[]"},"maximumConnectedPowerPer2String":{"type":"array","items":{"type":"number","example":5000,"uniqueKey":"inverterSpecifications.solarEdgeSpecifications.maximumConnectedPowerPer2String.items.[INDEX]","typeLabel":"number"},"uniqueKey":"inverterSpecifications.solarEdgeSpecifications.maximumConnectedPowerPer2String","typeLabel":"number[]"},"maximumConnectedPowerPerString":{"type":"array","items":{"type":"number","example":5000,"uniqueKey":"inverterSpecifications.solarEdgeSpecifications.maximumConnectedPowerPerString.items.[INDEX]","typeLabel":"number"},"uniqueKey":"inverterSpecifications.solarEdgeSpecifications.maximumConnectedPowerPerString","typeLabel":"number[]"},"maximumConnectedPowerPer3String":{"type":"array","items":{"type":"number","example":5000,"uniqueKey":"inverterSpecifications.solarEdgeSpecifications.maximumConnectedPowerPer3String.items.[INDEX]","typeLabel":"number"},"uniqueKey":"inverterSpecifications.solarEdgeSpecifications.maximumConnectedPowerPer3String","typeLabel":"number[]"},"maximumConnectedPowerPer4String":{"type":"array","items":{"type":"number","example":5000,"uniqueKey":"inverterSpecifications.solarEdgeSpecifications.maximumConnectedPowerPer4String.items.[INDEX]","typeLabel":"number"},"uniqueKey":"inverterSpecifications.solarEdgeSpecifications.maximumConnectedPowerPer4String","typeLabel":"number[]"}},"uniqueKey":"inverterSpecifications.solarEdgeSpecifications","typeLabel":"object"}},"uniqueKey":"inverterSpecifications","typeLabel":"object"},"complementaryEquipmentSpecifications":{"type":"object","properties":{"category":{"type":"object","properties":{"id":{"type":"string","example":"200000000","uniqueKey":"complementaryEquipmentSpecifications.category.id","typeLabel":"string"},"name":{"type":"string","example":"Categoria","uniqueKey":"complementaryEquipmentSpecifications.category.name","typeLabel":"string"},"type":{"type":"string","example":"Tipo da categoria","uniqueKey":"complementaryEquipmentSpecifications.category.type","typeLabel":"string"}},"uniqueKey":"complementaryEquipmentSpecifications.category","typeLabel":"object"}},"uniqueKey":"complementaryEquipmentSpecifications","typeLabel":"object"},"stringBoxSpecifications":{"type":"object","properties":{"inputAmount":{"type":"array","items":{"type":"number","example":1,"uniqueKey":"stringBoxSpecifications.inputAmount.items.[INDEX]","typeLabel":"number"},"uniqueKey":"stringBoxSpecifications.inputAmount","typeLabel":"number[]"},"outputAmount":{"type":"array","items":{"type":"number","example":1,"uniqueKey":"stringBoxSpecifications.outputAmount.items.[INDEX]","typeLabel":"number"},"uniqueKey":"stringBoxSpecifications.outputAmount","typeLabel":"number[]"},"maximumStringVoltage":{"type":"number","example":1000,"uniqueKey":"stringBoxSpecifications.maximumStringVoltage","typeLabel":"number"},"maximumStringCurrent":{"type":"number","example":20,"uniqueKey":"stringBoxSpecifications.maximumStringCurrent","typeLabel":"number"}},"uniqueKey":"stringBoxSpecifications","typeLabel":"object"},"customData":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Código de identificação do campo","uniqueKey":"customData.items.[INDEX].key","typeLabel":"string"},"value":{"oneOf":[{"type":"string","description":"Texto aberto","default":"0000","uniqueKey":"customData.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"integer","description":"Número inteiro","default":1,"uniqueKey":"customData.items.[INDEX].value.oneOf.1","typeLabel":"integer"},{"type":"number","description":"Número flutuante","default":900.9,"uniqueKey":"customData.items.[INDEX].value.oneOf.2","typeLabel":"number"},{"type":"array","items":{"type":"number","uniqueKey":"customData.items.[INDEX].value.oneOf.3.items.[INDEX]","typeLabel":"number"},"description":"Seleção de múltiplos items","default":[1,2,3],"uniqueKey":"customData.items.[INDEX].value.oneOf.3","typeLabel":"number[]"}],"uniqueKey":"customData.items.[INDEX].value","typeLabel":"string | integer | number | number[]"},"type":{"type":"string","enum":["text","date","integer","decimal","currency","currencyGeneric","singleSelect","multiSelect"],"description":"Tipo do campo","uniqueKey":"customData.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"customData.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customData","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"module / inverter / stringBox / complementaryEquipment","productCode":"codigo123","name":"Nome do produto ","manufacturer":"Nome do fabricante","model":"Modelo","baseprice":1000,"costPrice":500,"nominalMaxPower":500,"nominalOutputPower":10,"height":10,"width":10,"lenght":10,"weight":10,"volume":10,"featured":true,"featuredEcommerce":true,"isToSell":true,"isToSellIntegrator":true,"isToSellOptions":{"separatedSales":true,"closedKitSales":true,"mountKitSales":true},"storeSellOptions":{"separatedSales":true,"closedKitSales":true},"ecommerceSellOptions":{"separatedSales":true,"closedKitSales":true},"inventory":{"current":100,"reserved":50,"minimum":0},"inventoryByCenter":[{"center":"CD001","current":100,"reserved":50,"minimum":0}],"moduleSpecifications":{"ratedMaximumPower":500,"efficiency":10,"openCircuitVoltage":40.5,"shortCircuitCurrent":9.5,"maximumPowerVoltage":33.5,"maximumPowerCurrent":8.5,"cellType":"mono"},"inverterSpecifications":{"inverterType":"Tipo de inversor","connectionType":"Tipo de ligação","maximumInputPower":10,"maximumInputPowerPerString":500,"startVoltage":100,"minimumMPPTVoltage":150,"maximumMPPTVoltage":1000,"mpptAmount":2,"ratedOutputPower":10,"ratedOutputVoltage":400,"maximumOutputCurrent":50,"maximumInputCurrentPerMPPT":[20],"maximumInputCurrent":[40],"stringsPerMPPT":[20],"maximumCurrentDCConnector":[20],"maximumCurrent":[20],"solarEdgeSpecifications":{"compatibleInverters":[1],"minimumStringLength":[1],"maximumStringLength":[1],"maximumContinuousPowerPerString":[5000],"maximumConnectedPowerPer2String":[5000],"maximumConnectedPowerPerString":[5000],"maximumConnectedPowerPer3String":[5000],"maximumConnectedPowerPer4String":[5000]}},"complementaryEquipmentSpecifications":{"category":{"id":"200000000","name":"Categoria","type":"Tipo da categoria"}},"stringBoxSpecifications":{"inputAmount":[1],"outputAmount":[1],"maximumStringVoltage":1000,"maximumStringCurrent":20},"customData":[{"key":"\u003cstring>","value":"0000","type":"text"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"9169391e-9e07-4022-a280-f12649031373":{"description":"Esta funcionalidade está indisponível no momento","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"da5a0867-082c-4ce9-81f3-f0301a3a6123":{"description":"Não encontrado","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"fe9df1ba-6aef-46ef-a502-b01d50e3366d":{"description":"hardLimit: O limite de requisições por hora foi ultrapassado. Tente novamente mais tarde / timeLimit: O limite de 1 minuto de processamento de requisição por hora foi atingido. Tente novamente mais tarde","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"7b6e27b5-d39f-443b-94d8-802512c9f1e6":{"description":"Erro na API","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"f3945066-97c9-4db5-9517-db2e47bb3d96":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"3fac26e0-8dcf-42c3-945a-4c630c695244":{"url":"https://backend-pied-prod.piedadmin.com.br/api/v2"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi/openapi-v2.json"},"subdomain":"pied-3a231858","siteName":"PIED API","title":"Retorna informações sobre os equipamentos - PIED API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-10T13:07:16.875Z","originalFileLocation":"api-reference/v2/equipment/get-equipments.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Para uma resposta válida utilize o pageLimit corretamente. De outra forma irá retornar uma exceção.\">\u003cmeta data-mint-head name=\"application-name\" content=\"PIED API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pied-3a231858/CwY_i3PbErUauq7j/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/pied-3a231858/CwY_i3PbErUauq7j/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pied-3a231858/CwY_i3PbErUauq7j/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/pied-3a231858/CwY_i3PbErUauq7j/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/pied-3a231858/CwY_i3PbErUauq7j/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pied-3a231858/CwY_i3PbErUauq7j/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pied-3a231858/CwY_i3PbErUauq7j/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/pied-3a231858/CwY_i3PbErUauq7j/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/pied-3a231858/CwY_i3PbErUauq7j/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retorna informações sobre os equipamentos - PIED API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Para uma resposta válida utilize o pageLimit corretamente. De outra forma irá retornar uma exceção.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PIED API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pied.com.br/api-reference/v2/equipment/get-equipments\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pied-3a231858.mintlify.app/_mintlify/api/og/v2?division=Equipamentos\u0026amp;title=Retorna+informa%C3%A7%C3%B5es+sobre+os+equipamentos\u0026amp;description=Para+uma+resposta+v%C3%A1lida+utilize+o+pageLimit+corretamente.+De+outra+forma+ir%C3%A1+retornar+uma+exce%C3%A7%C3%A3o.\u0026amp;theme=7b2b4449c507a18d7354d695\u0026amp;signature=434c5a5085409fdb46698b0f5c829834a316b19581f113578a58393e2cacb440\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Retorna informações sobre os equipamentos - PIED API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Para uma resposta válida utilize o pageLimit corretamente. De outra forma irá retornar uma exceção.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pied-3a231858.mintlify.app/_mintlify/api/og/v2?division=Equipamentos\u0026amp;title=Retorna+informa%C3%A7%C3%B5es+sobre+os+equipamentos\u0026amp;description=Para+uma+resposta+v%C3%A1lida+utilize+o+pageLimit+corretamente.+De+outra+forma+ir%C3%A1+retornar+uma+exce%C3%A7%C3%A3o.\u0026amp;theme=7b2b4449c507a18d7354d695\u0026amp;signature=434c5a5085409fdb46698b0f5c829834a316b19581f113578a58393e2cacb440\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/pied-3a231858/CwY_i3PbErUauq7j/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PIED API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7A2BEF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pied.com.br/api-reference/v2/equipment/get-equipments\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v2/equipment/get-equipments.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pied.com.br/#organization\",\"name\":\"PIED API\",\"url\":\"https://docs.pied.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pied-3a231858/srnY5TMUiKfzvm-Y/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=srnY5TMUiKfzvm-Y\u0026q=85\u0026s=bf6f5b58ad371d63853387ff87e07cc6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pied.com.br#website\",\"name\":\"PIED API\",\"url\":\"https://docs.pied.com.br\",\"publisher\":{\"@id\":\"https://docs.pied.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pied.com.br/api-reference/v2/equipment/get-equipments#webpage\",\"url\":\"https://docs.pied.com.br/api-reference/v2/equipment/get-equipments\",\"name\":\"Retorna informações sobre os equipamentos\",\"description\":\"Para uma resposta válida utilize o pageLimit corretamente. De outra forma irá retornar uma exceção.\",\"dateModified\":\"2026-04-10T13:07:16.875Z\",\"isPartOf\":{\"@id\":\"https://docs.pied.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pied.com.br/api-reference/v2/equipment/get-equipments#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pied.com.br/api-reference/v2/equipment/get-equipments#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"PIED API\",\"item\":\"https://docs.pied.com.br\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retorna informações sobre os equipamentos\",\"item\":\"https://docs.pied.com.br/api-reference/v2/equipment/get-equipments\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pied.com.br/api-reference/v2/equipment/get-equipments#apireference\",\"headline\":\"Retorna informações sobre os equipamentos\",\"name\":\"Retorna informações sobre os equipamentos\",\"description\":\"Para uma resposta válida utilize o pageLimit corretamente. De outra forma irá retornar uma exceção.\",\"url\":\"https://docs.pied.com.br/api-reference/v2/equipment/get-equipments\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pied.com.br/api-reference/v2/equipment/get-equipments#webpage\"},\"dateModified\":\"2026-04-10T13:07:16.875Z\",\"publisher\":{\"@id\":\"https://docs.pied.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pied.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PIED API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"PIED API","nav":{"global":{"anchors":[{"anchor":"Nosso site","icon":"earth-americas","href":"https://pied.com.br"},{"anchor":"Central de ajuda","icon":"circle-question","href":"https://suportepied.tawk.help/"}]},"tabs":[{"tab":"Documentação","icon":"book","pages":[{"title":"Documentação","href":"/docs/introduction"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"Visão Geral","pages":[{"title":"Visão Geral da API","href":"/api-reference/v2/overview"}]},{"group":"Requests","pages":[{"title":"Retorna os dados dos orçamentos ou dos pedidos","openapi":"openapi/openapi-v2.json GET /requests/{requestType}/{pageNumber}/{pageLimit}","href":"/api-reference/v2/request/get-requests"},{"title":"Atualiza o status do orçamento/pedido","openapi":"openapi/openapi-v2.json PUT /request/updateStatus","href":"/api-reference/v2/request/put-status"},{"title":"Atualiza os dados de pagamento de um pedido","openapi":"openapi/openapi-v2.json PUT /request/{requestCode}/updatePayment","href":"/api-reference/v2/request/put-updatePayment"},{"title":"Retorna o status dos orçamentos/pedidos","openapi":"openapi/openapi-v1.json GET /request/{requestType}/statuses","href":"/api-reference/v1/request/get-statuses"},{"title":"Exclui o orçamento/pedido","openapi":"openapi/openapi-v1.json DELETE /request/{requestCode}","href":"/api-reference/v1/request/delete-request"},{"title":"Atualiza o responsável do orçamento/pedido","openapi":"openapi/openapi-v1.json PUT /request/{requestCode}/responsible","href":"/api-reference/v1/request/put-responsible"}]},{"group":"Empresas","pages":[{"title":"Cria uma ou mais empresas de energia","openapi":"openapi/openapi-v2.json POST /company","href":"/api-reference/v2/company/post-company"},{"title":"Retorna os dados das empresas de energia","openapi":"openapi/openapi-v1.json GET /companies/{pageNumber}/{pageLimit}","href":"/api-reference/v1/company/get-companies"},{"title":"Retorna os dados completos da empresa de energia solar","openapi":"openapi/openapi-v1.json GET /company/{companyMainContactEmail}","description":"Retorna os dados completos da empresa de energia solar, incluindo a lista de todos os orçamentos e pedidos desta empresa.","href":"/api-reference/v1/company/get-company"}]},{"group":"Equipamentos","pages":[{"title":"Retorna informações sobre os equipamentos","openapi":"openapi/openapi-v2.json GET /equipments/{pageNumber}/{pageLimit}","href":"/api-reference/v2/equipment/get-equipments"},{"title":"Atualiza o preço base e de custo de um ou mais equipamentos","openapi":"openapi/openapi-v2.json PUT /equipments/price","description":"Obs: Atualize simultaneamente até 50 preços de equipamentos. Atualização de preço de custo está disponível apenas para equipamentos.","href":"/api-reference/v2/equipment/put-price"},{"title":"Atualiza o estoque dos produtos","openapi":"openapi/openapi-v1.json PUT /equipments/stock","href":"/api-reference/v1/equipment/put-stock"}]},{"group":"Colaboradores","pages":[{"title":"Retorna os dados dos colaboradores","openapi":"openapi/openapi-v1.json GET /staffs/{pageNumber}/{pageLimit}","href":"/api-reference/v1/staff/get-staffs"},{"title":"Retorna os dados completos do colaborador","openapi":"openapi/openapi-v1.json GET /staff/{staffEmail}","href":"/api-reference/v1/staff/get-staff"}]},{"group":"Pagamentos","pages":[{"title":"Retorna lista de pagamentos agrupados por pedido","openapi":"openapi/openapi-v2.json GET /payments/{pageNumber}/{pageLimit}","href":"/api-reference/v2/payment/get-payments"},{"title":"Retorna detalhes do pagamento","openapi":"openapi/openapi-v2.json GET /payments/{paymentId}","href":"/api-reference/v2/payment/get-payment"},{"title":"Atualiza dados do pagamento","openapi":"openapi/openapi-v2.json PUT /payments/{paymentId}","href":"/api-reference/v2/payment/put-payment"},{"title":"Retorna formas de pagamento configuradas na plataforma","openapi":"openapi/openapi-v2.json GET /payment-methods","href":"/api-reference/v2/payment/get-payment-methods"}]},{"group":"Campos Customizados","pages":[{"title":"Retorna campos customizados relacionados a uma entidade","openapi":"openapi/openapi-v2.json GET /custom-fields/{parentType}/{parentId}","href":"/api-reference/v2/customField/get-customFields"},{"title":"Altera valores de campos customizados associados a uma entidade","openapi":"openapi/openapi-v2.json PUT /custom-fields/{parentType}/{parentId}","href":"/api-reference/v2/customField/put-customFields"}]},{"group":"Tarefas","pages":[{"title":"Retorna lista paginada de tarefas do distribuidor","openapi":"openapi/openapi-v2.json GET /task-plans/{pageNumber}/{pageLimit}","href":"/api-reference/v2/taskPlan/get-taskPlans"},{"title":"Retorna detalhes de uma tarefa","openapi":"openapi/openapi-v2.json GET /task-plans/{taskPlanId}","href":"/api-reference/v2/taskPlan/get-taskPlan"},{"title":"Cria uma nova tarefa","openapi":"openapi/openapi-v2.json POST /task-plans","href":"/api-reference/v2/taskPlan/post-taskPlan"},{"title":"Atualiza uma tarefa","openapi":"openapi/openapi-v2.json PUT /task-plans/{taskPlanId}","href":"/api-reference/v2/taskPlan/put-taskPlan"},{"title":"Remove uma tarefa (soft delete)","openapi":"openapi/openapi-v2.json DELETE /task-plans/{taskPlanId}","href":"/api-reference/v2/taskPlan/delete-taskPlan"}]},{"group":"Comentários","pages":[{"title":"Retorna lista paginada de comentários de uma entidade","openapi":"openapi/openapi-v2.json GET /comments/{pageNumber}/{pageLimit}","href":"/api-reference/v2/comment/get-comments"},{"title":"Cria um novo comentário","openapi":"openapi/openapi-v2.json POST /comments","href":"/api-reference/v2/comment/post-comment"},{"title":"Atualiza um comentário","openapi":"openapi/openapi-v2.json PUT /comments/{commentId}","href":"/api-reference/v2/comment/put-comment"},{"title":"Remove um comentário (soft delete)","openapi":"openapi/openapi-v2.json DELETE /comments/{commentId}","href":"/api-reference/v2/comment/delete-comment"},{"title":"Cria uma resposta em um comentário","openapi":"openapi/openapi-v2.json POST /comments/{commentId}/reply","href":"/api-reference/v2/comment/post-comment-reply"},{"title":"Atualiza uma resposta de comentário","openapi":"openapi/openapi-v2.json PUT /comments/{commentId}/reply/{replyId}","href":"/api-reference/v2/comment/put-comment-reply"},{"title":"Remove uma resposta de comentário","openapi":"openapi/openapi-v2.json DELETE /comments/{commentId}/reply/{replyId}","href":"/api-reference/v2/comment/delete-comment-reply"}]},{"group":"Kits","pages":[{"title":"Obter kits disponíveis","openapi":"openapi/kits.json POST /v2/kits","href":"/api-reference/v2/kits/post-kits"},{"title":"Obter filtros disponíveis","openapi":"openapi/kits.json GET /v2/kits/filter","href":"/api-reference/v2/kits/get-kits-filter"}]}]},{"tab":"Webhooks","icon":"webhook","pages":[{"title":"Webhooks","href":"/webhooks/introduction"}]},{"tab":"Integrações","icon":"plug","pages":[{"title":"Integrações","href":"/integrations/introduction"}]}]},"basePath":"","title":"Retorna informações sobre os equipamentos - PIED API","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}