Árvore de páginas

Versões comparadas

Chave

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

Para acessar os dados a requisição é a seguinteEste método é responsável pela consulta de lojas disponíveis na retaguarda. Ao realizarmos uma requisição na API de lojas, será gerada uma consulta com todos os dados da loja. 

  • Endpoint: /api/retaguardapdvsyncclient/v2/lojas/{CNPJ}/{CodigoIdentificacaoLoja}
  • Método: GET
  • Autenticação: Bearer token
  • Permissão: Retaguarda Client

Para esse endpoint, alguns parâmetro precisam ser enviados na requisição. Estes parâmetros são:

...

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
}

...