Histórico da Página

Este método é responsável pelo envio pela criação de statusloja

Endpoint: /api/retaguarda/v2/lojas
Método: Post
Autenticação: Bearer token
Permissão: Retaguarda

Este endpoint recebe uma lista de lojas para que possam ser enviados vários na mesma requisição

Aviso
Para que a baixa da loja criada ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 1 = loja

Expandir

title	Exemplo de body da requisição

[
{
"bairro": "string",
"cep": "string",
"loteOrigemcidade": "string",
"idInquilinocnpj": "string",
"idRetaguardacodigoIdentificacaoLoja": "string",
"idProprietariocodigoMaster": "string",
"razaoSocialcodigoMunicipioIbge": "string",
"nomeFantasiacodigoOrganizacional": "string",
"cnpjcodigoUFIBGE": "string",
"inscricaoEstadualcomplemento": "string",
"endereco": "string",
"numeroestado": "string",
"bairroidDominioManutencao": "string",
"cidadeidInquilino": "string",
"estadoidProprietario": "string",
"siglaUfidRetaguarda": "string",
"CodigoUFIBGEidRetaguardaRede": "string",
"CodigoMunicipioIbgeinscricaoEstadual": "string",
"cepinscricaoMunicipal": "string",
"complementoloteOrigem": "string",
"modeloFiscal": 0,
"nomeFantasia": "string",
"regimeTributarionomeMaster": 0"string",
"redenumero": "string",
"numeroLoja": "string",
"telefonerazaoSocial": "string",
"inscricaoMunicipalrede": "string",
"codigoIdentificacaoLoja"regimeTributario": 0,
"siglaUf": "string",
"situacao": 1,
"telefone": "string"
}
]

Expandir

title	Definição dos campos de requisição

Campo	Tipo	Descrição

Observações	Obrigatório	Regras do campo

Observações


loteOrigem	string	Código do lote	Sim
idInquilino	string	Identificador do inquilino	Sim
idRetaguarda	string	Identificador da loja na retaguarda	Sim	Tamanho máximo: 100 caracteres
idProprietario	string	Identificador do proprietário. (Adicionando na criação do compartilhamento)	Sim
razaoSocial	string	Razão social da loja	Sim	Tamanho máximo (50)
nomeFantasia	string	Nome Fantasia da loja	Sim	Tamanho máximo (50)
cnpj	string	CNPJ da loja	Sim	Tamanho máximo (14)
inscricaoEstadual	string	Inscrição estadual da loja	Sim	Tamanho máximo (15) Tamanho mínimo (2)
endereco	string	Endereço da loja	Sim	Tamanho máximo (200) Tamanho mínimo (2)
numero	string	Número do local da loja	Não	Tamanho máximo (10)
bairro	string	Bairro da loja	Sim	Tamanho máximo (150) Tamanho mínimo (2)
cidade	sring	Cidade da loja	Sim	Tamanho máximo (150) Tamanho mínimo (2)
estado	string	Estado da loja	Sim	Tamanho máximo (50)
siglaUf	string	Sigla do estado da loja	Sim	Tamanho máximo (2) Tamanho mínimo (2)
CodigoUFIBGE	string	Código do estado	Sim	Tamanho igual (2)
CodigoMunicipioIbge	string	Código do município	Não	Tamanho igual (7)
cep	string	Cep da lona	Sim	Tamanho máximo (8)
complemento	string	Complemente do endereço da loja	Não	Tamanho máximo (100) Tamanho mínimo (2)
modeloFiscal

int

Enum	Modelo fiscal utilizado (Tipos abaixo)	Não		Enviar um dos tipos abaixo. Caso não tenha definido o valor deste campo, informar "null" ou não enviar esse campo na requisição
regimeTributario	int	Regime tributário utilizado (Tipos abaixo)	Sim
rede	string	Rede da loja	Sim	Tamanho máximo (40)
numeroLoja	string	Numero da loja	Sim	Tamanho máximo (30)
telefone	string	Telefone da loja	Não		Informar somente os números
inscricaoMunicipal	string	Inscrição municipal da loja	Não	Tamanho máximo (15)
codigoIdentificacaoLoja	string	Código de identificação da loja	Sim	Tamanho máximo (20)
situacao	int	Situação da loja (Tipos abaixo)	Sim
idRetaguardaRede	string	Identificador da rede naretaguarda	Não	Tamanho máximo (100)
codigoMaster	string	Código master	Não	Tamanho máximo (50)
nomeMaster	string	Nome master	Não	Tamanho máximo (50)
idDominioManutencao	string	Identificador dominio manutenção	Não
codigoOrganizacional	string	Codigo Organizacional	Não

HTTP 400 - Bad Request

Expandir

title	Tipos de Regime Tributário

Código	Nome
0	SimplesNacional
1	RegimeNormal

Expandir

title

Expandir

title	Retornos	Tipos de Modelo fiscal

Código	Nome
0	NaoConfigurado
1	SAT
2	NFCe
3	MFE

Expandir

title	Retornos

{
"success": true,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Retorno ocorre quando uma campo obrigatório não é enviado

{
  "code": "",
  "message": "",
  "detailedMessage": "",
  "helpUrl": "",
  "details": [
  {
  "guid": "23d3d6cd-084d-413a-8b1f-f596df5a9fe6",
  "code": "CQIFlap.Pber.Pbagebyr.Qbznva.Ragvgvrf.FgnghfFreivpb.FgnghfFreivpb+Reebe.5",
  "message": "O Status deve conter um status.",
  "detailedMessage": "StatusShouldHaveStatusSpecification"
  }
  ]
}

Expandir

title	Definição dos campos de retorno

Campo	Tipo	Descrição
Success	bool	Indica se a criação da loja foi feita com sucesso
Message	string	Caso ocorra erros durante a criação da loja eles serão enviados nesse campo
Data	objeto	Objeto loja criado
Errors	Lista	Listas com os erros encontrados no processo
TotalTime	int	tempo da requisição
NumberOfRecords	int	número de dados inseridos

Expandir

title	HTTP 200 - OK

{
  "success": true,
  "message": "",
  "data": {
  "aplicacao": "AplicacaoTeste",
  "retaguarda": "RetaguardaTeste",
  "servico": "ServicoTeste",
  "idLojaRetaguarda": "IdLojaRetaguardaTeste",
  "dispositivo": "DispositivoTeste",
  "idDevice": "IdDeviceTeste",
  "status": "StatusTeste",
  "dataServidor": "2023-11-22T13:00:00Z",
  "idInquilino": "IdInquilinoTeste",
  "dataAtualizacao": "2023-11-22T15:24:38.1057876Z",
  "dataCadastro": "2023-11-22T15:24:38.105787Z",
  "id": "19",
  "_expandables": []
  }
}

Expandir

title	HTTP 400 - Bad Request

Árvore de páginas

Versões comparadas

Versão antiga 4

Nova versão Atual

Chave