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 |
---|
|
[ { "loteOrigem": "string", "idInquilino": "string", "idRetaguarda": "string", "idProprietario": "string", "razaoSocial": "string", "nomeFantasia": "string", "cnpj": "string", "inscricaoEstadual": "string", "endereco": "string", "numero": "string", "bairro": "string", "cidade": "string", "estado": "string", "siglaUf": "string", "CodigoUFIBGE": "string", "CodigoMunicipioIbge": "string", "cep": "string", "complemento": "string", "modeloFiscal": 0, "regimeTributario":0, "rede": "string", "numeroLoja": "string", "telefone": "string", "inscricaoMunicipal": "string", "codigoIdentificacaoLoja": "string", "situacao":1 } ] |
Expandir |
---|
title | Definição dos campos de requisição |
---|
|
Campo | Tipo | Descrição | Obrigatório | 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 caracteres | nomeFantasia | string | Nome Fantasia da loja | Sim
| Tamanho máximo: 50 caracteres | cnpj | string | CNPJ da loja | Sim |
| inscricaoEstadual | string | Inscrição estadual da loja | Sim |
| endereco | string | Endereço da loja | Sim
| Tamanho máximo: 60 caracteres | numero | string | Número do local da loja | Não |
| bairro | string | Bairro da loja | Sim
| Tamanho máximo: 60 caracteres | cidade | sring | Cidade da loja | Sim
| Tamanho máximo: 60 caracteres | estado | string | Estado da loja | Sim
| Tamanho máximo: 50 caracteres | siglaUf | string | Sigla do estado da loja | Sim |
| CodigoUFIBGE | string | Código do estado | Sim |
| CodigoMunicipioIbge | string | Código do município | Sim |
| cep | string | Cep da lona | Sim |
| complemento | string | Complemente do endereço da loja | Não
| Tamanho máximo: 60 caracteres | modeloFiscal | intEnum | 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: 50 caracteres | numeroLoja | string | Numero da loja | Não |
| telefone | string | Telefone da loja | Sim
| Passar somente os números | inscricaoMunicipal | string | Inscrição municipal da loja | Não |
| codigoIdentificacaoLoja | string | Código de identificação da loja | Sim
| Tamanho máximo: 20 caracteres | situacao | int | Situação da loja (Tipos abaixo) | Sim |
|
|
Expandir |
---|
title | Retornos | Tipos de Regime Tributário |
---|
|
Código | Nome |
---|
0 | SimplesNacional | 1 | RegimeNormal |
|
Expandir |
---|
title | Tipos de Modelo fiscal |
---|
|
Código | Nome |
---|
0 | NaoConfigurado | 1 | SAT | 2 | NFCe | 3 | MFE |
|
Expandir |
---|
|
{ "success": true, "message": "", "data": null, "errors": null, "totalTime": 0, "numberOfRecords": 0 } |
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 |
| 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 |
---|
|
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"
}
]
}