Histórico da Página

Este método é responsável pelo envio de status

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

Expandir

title	Exemplo de body da requisição

{
    "idInquilino": "IdInquilinoTeste",
    "aplicacao":"AplicacaoTeste",
    "retaguarda": "RetaguardaTeste",
    "servico": "ServicoTeste",
    "idLojaRetaguarda": "IdLojaRetaguardaTeste",
    "dispositivo": "DispositivoTeste",
    "idDevice": "IdDeviceTeste",
    "status": "StatusTeste",
    "dataServidor": "2023-11-22T13:00:00.000Z"
}

[
{
"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

Não nulo

Campo	Tipo	Descrição	Observações
loteOrigem	string	Código do lote
idInquilino	string	Id Identificador do inquilino que enviou o status	Não Nulo
aplicacao	sring	Aplicação utilizada ex.: WSH/PDVSync	Não nulo
retaguarda	string	Retaguarda utilizada pelo serviço ex.: Winthor/Protheus	Não nulo
servico	string	Serviço que enviou o status ex.: PDVSync.Client.Down/PDVSync.Client.UP/Client.WSH/ClientProtheus	Não nulo
idLojaRetaguarda	string	Id retaguarda da loja que está utilizando o serviço	Não nulo
dispositivo	string	Dispositivo que está utilizando o serviço	Nullable
idDevice	string	Id do dispoisitivo que está utilizando o serviço	Nullable
status	string	Status do serviço ex.: Ativo/Inativo	Não nulo
dataServidor	Timestamp	Data que o serviço enviou o status OBS: Enviar a data com timezone

idRetaguarda	string	Identificador da loja na retaguarda
idProprietario	string	Identificador do proprietário. (Adicionando na criação do compartilhamento)
razaoSocial	string	Razão social da loja
nomeFantasia	string	Nome Fantasia da loja
cnpj	string	CNPJ da loja
inscricaoEstadual	string	Inscrição estadual da loja
endereco	string	Endereço da loja
numero	string	Número do local da loja
bairro	string	Bairro da loja
cidade	sring	Cidade da loja
estado	string	Estado da loja
siglaUf	string	Sigla do estado da loja
CodigoUFIBGE	string	Código do estado
CodigoMunicipioIbge	string	Código do município
cep	string	Cep da lona
complemento	string	Complemente do endereço da loja
modeloFiscal	int	Modelo fiscal utilizado (Tipos abaixo)
regimeTributario	int	Regime tributário utilizado (Tipos abaixo)
rede	string	Rede da loja
numeroLoja	string	Numero da loja
telefone	string	Telefone da loja
inscricaoMunicipal	string	Inscrição municipal da loja
codigoIdentificacaoLoja	string	Código de identificação da loja
situacao	int	Situação da loja (Tipos abaixo)

Expandir

title	Retornos

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

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"
  }
  ]
}

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão 3

Chave