Árvore de páginas

Endpoint responsável pelo retorno do status do loja lote

Para acessar os dados a requisição é a seguinte

  • Endpoint: /api/retaguarda/v2/lojaloteretornos/{IdInquilino}/{LoteOrigem}
  • Método: GET
  • Autenticação: Bearer token
  • Permissão: Retaguarda

Os parâmetros para a requisição estão abaixo

Campo

Tipo

Descrição

Observações

IdInquilinostringIdentificador do InquilinoObrigatório
IdRetaguardaLojastringIdentificador da loja na retaguarda

Obrigatório

Retornos

    Campo

    Tipo

    Descrição

    Campo Tipo Indica se a requisição foi feita com sucesso
    Success Booleano Mensagem de retorno de erros
    Message String Lista com os créditos retornados
    Data Lista de Objetos Lista de objetos de retorno
    Data.Lote String Número do lote
    Data.LoteOrigem String Número do lote origem
    Data.Status Inteiro Status do lote
    Data.IdOrigem String Identificador da origem
    Data.ErrosIdentificados Lista de Objetos Lista de erros 
    Data.ErrosIdentificados.TipoLote Inteiro Tipo do lote
    Data.ErrosIdentificados.IdRetaguarda String Identificador do lote na retaguarda
    Data.ErrosIdentificados.Erro String Identificador do erro
    Data.ErrosIdentificados.TipoLojaLote Inteiro Identificador do tipo loja lote
    Data.ErrosIdentificados.Pagina Inteiro Número da página
    Data.ErrosIdentificados.Hasnext Booleano Indica se há mais páginas
    Data.IdRetaguardaLoja String Identificador da loja na retaguarda
    Data.IdInquilino String Identificador do inquilino
    Data.DataAtualizacao Datetime Data de atualização
    Data.DataCadastro Datetime Data de cadastro
    Data.Id String Identificador do loja lote
    Errors Objeto Lista de erros
    TotalTime Inteiro Tempo total da requisição
    NumberOfRecords Inteiro Número de registros


    {
        "success": true,
        "message": "string",
        "data": [
            {
                "lote": "string",
                "loteOrigem": "string",
                "status": 0,
                "idOrigem": "string",
                "errosIdentificados": [
                    {
                        "tipoLote": 0,
                        "idRetaguarda": "string",
                        "erro": "string",
                        "tipoLojaLote": 0,
                        "pagina": 0,
                        "hasnext": true
                    }
                ],
                "idRetaguardaLoja": "string",
                "idInquilino": "string",
                "dataAtualizacao": "2024-06-20T15:40:31.700Z",
                "dataCadastro": "2024-06-20T15:40:31.700Z",
                "id": "string"
            }
        ],
        "errors": {},
        "totalTime": 0,
        "numberOfRecords": 0
    }

    Campo

    Tipo

    Descrição

    Observação

    Success

    bool

    Indica se a requisição foi feita com sucesso


    Data Objeto Objeto de retorno
    Errors Lista de objetos Lista de erros Somente é retornado na V3
    Message string Mensagem de retorno de erros
    NumberOfRecords Int Número de registros
    TotalTime Int Tempo total da requisição


    {
        "success": false,
        "message": "string",
        "data": null,
        "errors": null,
        "totalTime": 0,
        "numberOfRecords": 0
    }





    • Sem rótulos