Company
IMPORTANTE
Para mais detalhes sobre os dados de entrada e saída consulte a documentação da API.
Get Company Details#
Este método retorna os detalhes de uma empresa específica.
Recebe o argumento:
companyId: (obrigatório) id da Empresa -string.
Retorna um json:
- id:
string. - document:
string. - name:
string. - logo:
string. - url:
string. - segment:
string.
- id:
Get Company List#
Este método retorna todas as empresas da sua conta.
Recebe os argumentos:
page: (opcional) número de uma página especifica -int.pageSize: (opcional) quantidade de items por página (por padrão tem o valor 20) -int.
Retorna um json:
data: conteúdo da resposta.- results:
array. - pageNumber:
int. - nextPage:
string.
- results:
status: status da requisição.
Get Company Store#
Este método retorna todas as lojas de uma empresa.
Recebe os argumentos:
companyId: (obrigatório) id da empresa -string.page: (opcional) número de uma página especifica -int.pageSize: (opcional) quantidade de items por página (por padrão tem o valor 20) -int.
Retorna um json:
- results:
array. - pageNumber:
int. - nextPage:
string.
- results:
Update Company#
Este método atualiza dados de uma empresa.
Recebe o argumento
paramsque é um objeto com os campos:companyId: (obrigatório) id da empresa -string.
Recebe o argumento
bodyque é um objeto com os campos:document: (obrigatório) documento de identificaçao (CNPJ/CPF) -string.name:(obrigatório) nome da empresa -string.logo: (opcional) url da logo da empresa -string.url: (opcional) url da página de impacto da empresa -string.segment: (opcional) segmento da empresa -string.
Retorna um json:
- id:
string. - document:
string. - name:
string. - logo:
string. - url:
string. - segment:
string.
- id:
Create Company#
Este método cria uma empresa.
Recebe os argumentos :
document: (obrigatório) documento de identificaçao (CNPJ/CPF) -string.name: nome da empresa -string.logo: url da logo da empresa -string.url: url da página de impacto da empresa -string.segment: segmento da empresa -string.
Retorna um json:
- id:
string. - document:
string. - name:
string. - logo:
string. - url:
string. - segment:
string.
- id: