...
| Expandir |
|---|
| title | Definição dos campos de requisição |
|---|
|
Campo | Tipo | Descrição | Observações |
|---|
loteOrigem | string | Código do lote | Obrigatório | idInquilino | string | Identificador do inquilino | Obrigatório | idRetaguarda | string | Identificador da loja na retaguarda | Obrigatório Tamanho máximo: 100 caracteres | idProprietario | string | Identificador do proprietário. (Adicionando na criação do compartilhamento) | Obrigatório | razaoSocial | string | Razão social da loja | Obrigatório Tamanho máximo: 50 caracteres | nomeFantasia | string | Nome Fantasia da loja | Obrigatório Tamanho máximo: 50 caracteres | cnpj | string | CNPJ da loja | Obrigatório | inscricaoEstadual | string | Inscrição estadual da loja | Obrigatório | endereco | string | Endereço da loja | Obrigatório Tamanho máximo: 60 caracteres | numero | string | Número do local da loja | Opcional | bairro | string | Bairro da loja | Obrigatório Tamanho máximo: 60 caracteres | cidade | sring | Cidade da loja | Obrigatório Tamanho máximo: 60 caracteres | estado | string | Estado da loja | Obrigatório Tamanho máximo: 50 caracteres | siglaUf | string | Sigla do estado da loja | Obrigatório | CodigoUFIBGE | string | Código do estado | Obrigatório | CodigoMunicipioIbge | string | Código do município | Obrigatório | cep | string | Cep da lona | Obrigatório | complemento | string | Complemente do endereço da loja | Opcional Tamanho máximo: 60 caracteres | modeloFiscal | int | Modelo fiscal utilizado (Tipos abaixo) | Opcional | regimeTributario | int | Regime tributário utilizado (Tipos abaixo) | Obrigatório | rede | string | Rede da loja | Obrigatório Tamanho máximo: 50 caracteres | numeroLoja | string | Numero da loja | Opcional | telefone | string | Telefone da loja | Obrigatório Passar somente os números | inscricaoMunicipal | string | Inscrição municipal da loja | Opcional | codigoIdentificacaoLoja | string | Código de identificação da loja | Obrigatório Tamanho máximo: 20 caracteres | situacao | int | Situação da loja (Tipos abaixo) | Obrigatório |
|
| Expandir |
|---|
| title | HTTP 400 - Bad RequestTipos de Regime Tributário |
|---|
|
| Código | Nome |
|---|
| 0 | SimplesNacional | | 1 | RegimeNormal |
|
| Expandir |
|---|
| title | Retornos | 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 |
| Expandir |
|---|
| {
"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"
}
]
}
