TOTVS Varejo Franquias e Redes

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 2

changes.mady.by.user Erik Lopes Vitelli

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Erik Lopes Vitelli

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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


Indica que ocorreu alguma problema com o loja lote e deve-se verificar
Expandir
titleDefinição dos campos de retorno
Expandir
title200 OK

Campo

Tipo

Descrição

successBooleanoIndica se a requisição deu sucesso
messageStringMensagem de retorno 
dataObjetoObjeto retornado
data.idRetaguardaStringIdentificador da retaguarda
data.razaoSocialStringRazão social
data.nomeFantasiaStringNome fantasia
data.cnpjStringCNPJ
data.codigoIdentificacaoLojaStringCódigo de identificação da loja
data.situacaoInteiroSituação da loja
data.modeloFiscalInteiroModelo fiscal
data.regimeTributarioInteiroRegime tributário
data.numeroLojaStringNúmero da loja
data.tenantIdStringIdentificador do tenant
data.statusLicenciamentoInteiroStatus do licenciamento
data.idInquilinoStringIdentificador do inquilino
data.dataAtualizacaoData/HoraUltima data de atualização da loja
data.dataCadastroData/HoraData de cadastro da loja
data.idStringIdentificador da loja no POSH
errorsListaLista de erros
totalTimeInteiroTempo de busca
numberOfRecordsInteiroNumero de linhas
Expandir
titleRetorno 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
}

Expandir
titleDefinição dos campos de retorno

Campo

Tipo

Descrição

successBooleanoIndica se a requisição deu sucesso
messageStringMensagem de retorno 
dataObjetoObjeto retornado
data.idRetaguardaStringIdentificador da retaguarda
data.razaoSocialStringdata.nomeFantasiaStringdata.cnpjStringdata.codigoIdentificacaoLojaStringdata.situacaoInteirodata.modeloFiscalInteirodata.regimeTributarioInteirodata.numeroLojaStringdata.tenantIdNulodata.statusLicenciamentoInteirodata.idInquilinoStringdata.dataAtualizacaoData/Horadata.dataCadastroData/Horadata.idStringdata._expandablesLista VaziaerrorsNulototalTimeInteironumberOfRecordsInteiro
Expandir
titleStatus do loja lote
CódigoNomeDescrição
0EmPreparacao

Indica que o POSH está criando o loja lote

1EmProcessamentoIndica que o POSH está validando o loja lote
2DisponivelIndica que o loja lote está disponível para a baixa pelo PDV Omni
3IndisponivelIndica que o loja lote está indisponível para baixa pelo PDV Omni
4EmProcessoDeBaixaIndica que o loja lote está sendo baixado pelo PDV Omni
5BaixadoComSucessoIndica que todos os dados enviados para o loja lote foram integrados com sucesso ao PDV Omni
6BaixadoComErroIndica que ao menos um item deu erro na integração com o PDV Omni
7EnviadoComSucessoIndica que o loja lote foi envidado com sucesso para a retaguarda
8EnviadoComErroIndica que o loja lote não foi enviado com sucesso para a retaguarda
9ComProblemaVerificar