GET /api/retaguarda/v2/Loja

Para acessar os dados a requisição é a seguinte

Endpoint: /api/retaguarda/v2/lojas/{CNPJ}/{CodigoIdentificacaoLoja}
Método: GET
Autenticação: Bearer token
Permissão: Retaguarda

Para esse endpoint, alguns parâmetro precisam ser enviados na requisição. Estes parâmetros são:

Parametro	Descrição	Tipo	Observação
CNPJ	CNPJ da loja que será buscada	string	Obrigatório
CodigoIdentificacaoLoja	Código de identificação de loja	string	Opcional

Os parâmetros opcionais funcionam como um filtro de dados, caso estejam preenchidos ele trará somente os dados relacionados ao filtro.

Definição dos campos de retorno

200 OK

Campo	Tipo	Descrição
success	Booleano	Indica se a requisição deu sucesso
message	String	Mensagem de retorno
data	Objeto	Objeto retornado
data.idRetaguarda	String	Identificador da retaguarda
data.razaoSocial	String	Razão social
data.nomeFantasia	String	Nome fantasia
data.cnpj	String	CNPJ
data.codigoIdentificacaoLoja	String	Código de identificação da loja
data.situacao	Inteiro	Situação da loja
data.modeloFiscal	Inteiro	Modelo fiscal
data.regimeTributario	Inteiro	Regime tributário
data.numeroLoja	String	Número da loja
data.tenantId	String	Identificador do tenant
data.statusLicenciamento	Inteiro	Status do licenciamento
data.idInquilino	String	Identificador do inquilino
data.dataAtualizacao	Data/Hora	Ultima data de atualização da loja
data.dataCadastro	Data/Hora	Data de cadastro da loja
data.id	String	Identificador da loja no POSH
errors	Lista	Lista de erros
totalTime	Inteiro	Tempo de busca
numberOfRecords	Inteiro	Numero de linhas

Retorno da requisição

{
"success": true,
"message": "string",
"data": {
"idRetaguarda": "string",
"razaoSocial": "string",
"nomeFantasia": "string",
"cnpj": "string",
"codigoIdentificacaoLoja": "string",
"situacao": 1,
"modeloFiscal": 0,
"regimeTributario": 0,
"numeroLoja": "string",
"tenantId": null,
"statusLicenciamento": 0,
"idInquilino": "string",
"dataAtualizacao": "datetime",
"dataCadastro": "datetime",
"id": "1",
"_expandables": []
},
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Atalhos

Árvore de páginas