Árvore de páginas

Versões comparadas

Chave

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

...

Deck of Cards
idcredito_consulta_get
Card
label200 - OK

Campo

Tipo

Descrição

SuccessBooleanoIndica se a requisição foi feita com sucesso
MessageStringMensagem de retorno em
DataLista de ObjetosLista com as pré-vendas
Data[].ClienteObjetoObjeto de cliente
Data[].Cliente.NomeStringNome do cliente
Data[].Cliente.CpfCnpjStringCPF ou CNPJ do cliente
Data[].OfflineBooleano
Data[].SituacaoPreVendaStringSituação da pré-venda
Data[].IdLojaRetaguardaStringIdentificação da loja na retaguarda
Data[].IdOperadorRetaguardaStringIdentificação do operador na retaguarda
Data[].TotalLiquidoDecimalTotal liquido da pré-venda
Data[].DescontoPercentualTotalDecimalDesconto percentual total da pré-venda
Data[].DescontoTotalDecimalDesconto total da pré-venda
Data[].AcrescimoPercentualTotalDecimalAcrescímo Acréscimo Percentual total da pré-venda
Data[].AcrescimoTotalDecimalAcrescío Acréscimo total da pré-venda
Data[].FreteTotalDecimalValor total do frete
Data[].TotalBrutoDecimalTotal bruto da pré-venda
Data[].MultiplosPedidosBooleanoIndica se são multiplos múltiplos pedidos
Data[].DataCadastroData/HoraData de cadastro
Data[].IdInteiroId
Data[].IdRetaguardaStringIdentificador da pré-venda na retaguarda
ErrorsLista de objetosLista de erros
TotalTimeInteiroTempo total da requisição
NumberOfRecordsInteiroNúmero de registros


{
    "success": true,
    "message": "String",
    "data": [
        {
            "cliente": {
                "nome": "String",
                "cpfCnpj": "String"
            },
            "offline": false,
            "situacaoPreVenda": "String",
            "idLojaRetaguarda": "String",
            "idOperadorRetaguarda": "String",
            "totalLiquido": 0.0,
            "descontoPercentualTotal": 0.0,
            "descontoTotal": 0.0,
            "acrescimoPercentualTotal": 0.0,
            "acrescimoTotal": 0.0,
            "freteTotal": 0.0,
            "totalBruto": 0.0,
            "multiplosPedidos": false,
            "dataCadastro": "0001-01-01T00:00:00",
            "id": 0,
            "idRetaguarda": "String"
        }
    ],
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Card
label400 - Bad Request

Campo

Tipo

Descrição

ObeservaçãoObservação

SuccessboolIndica se a requisição foi feita com sucesso
MessagestringMensagem de retorno de erros
DataObjetoObjeto de retonroretorno
ErrorsLista de objetosLista de errosSomente é retornado na V3
TotalTimeIntTempo total da requisição
NumberOfRecordsIntNúmero de registros


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