Pular para o conteúdo principal

ResultadoOfPaginaOfPedidoResponse

dados object

O conteúdo da resposta. Ausente ou nulo quando sucesso é falso.

itens object[]obrigatório

Os itens desta página.

  • Array [
  • protocolointeger<int64>

    Protocolo — o código do pré-documento no ERP.

    chavePedidoEcommercenull | stringanulável

    Chave do pedido na plataforma de e-commerce, como a loja enviou.

    filialinteger<int32>

    Código da filial. É sempre a filial da credencial.

    operacaointeger<int32>

    Código da operação fiscal usada.

    operacaoDescricaonull | stringanulável

    Nome da operação fiscal.

    dataEmissaostring<date-time>

    Data de emissão do pedido.

    statusStatusPreDocumento

    Situação do pedido.

    Valores possíveis: [20, 21, 22, 23, 24, 25, 26, 27, 28]

    statusDescricaonull | stringanulável

    Texto correspondente a status.

    idEnvioEcommerce(null | integer)<int64>anulável

    Identificador do envio na plataforma, quando informado.

    valorSubTotalnumber<double>

    Subtotal do pedido como a loja informou.

    valorSubTotalItensnumber<double>

    Soma do subtotal dos itens, calculada no recebimento.

    valorDescontoItensnumber<double>

    Soma dos descontos aplicados aos itens.

    valorAcrescimoItensnumber<double>

    Soma dos acréscimos aplicados aos itens.

    valorTotalItensnumber<double>

    Soma do valor líquido dos itens.

    valorFretenumber<double>

    Valor do frete do pedido.

    valorTotalnumber<double>

    Valor total do pedido, como a loja informou.

    valorCustonumber<double>

    Soma do custo dos itens.

    percentualLucronumber<double>

    Percentual de lucro do pedido.

    observacaonull | stringanulável

    Observação livre informada no envio.

    ativoboolean

    Se o pedido está ativo no ERP. Cancelamento no ERP desativa o pré-documento.

    itens object[]

    Itens do pedido.

  • Array [
  • numeroIteminteger<int32>

    Sequência do item no pedido, a partir de 1.

    produto(null | integer)<int64>anulável

    Código do produto no ERP.

    descricaostring

    Descrição gravada no item: a da loja, ou a do cadastro quando a loja não informou.

    quantidadenumber<double>

    Quantidade vendida.

    valorUnitarionumber<double>

    Preço unitário.

    valorSubTotalnumber<double>

    Quantidade vezes o valor unitário.

    valorDescontonumber<double>

    Desconto próprio do item.

    valorAcrescimonumber<double>

    Acréscimo próprio do item.

    valorTotalnumber<double>

    Valor do item após desconto e acréscimo próprios.

    valorDescontoRateadonumber<double>

    Parcela do desconto do pedido rateada neste item.

    valorAcrescimoRateadonumber<double>

    Parcela do acréscimo do pedido rateada neste item.

    valorFreteRateadonumber<double>

    Parcela do frete do pedido rateada neste item.

    valorLiquidonumber<double>

    Valor final do item, com rateios e frete.

    valorCustonumber<double>

    Custo do item informado pela loja.

    percentualLucronumber<double>

    Percentual de lucro informado pela loja.

    tabelaPrecointeger<int32>

    Código da tabela de preço usada no item.

    promocaoboolean

    Indica se o item foi vendido em promoção.

    ativoboolean

    Indica se o item está ativo no pré-documento.

  • ]
  • pagamentos object[]

    Pagamentos do pedido.

  • Array [
  • meioPagamentoMeioPagamento

    Meio de pagamento, na numeração fiscal do ERP.

    Valores possíveis: [1, 2, 3, 4, 5, 10, 11, 12, 13, 15, 16, 17, 18, 19, 23, 24, 90, 99, 999]

    meioPagamentoDescricaonull | stringanulável

    Texto correspondente a meioPagamento.

    valornumber<double>

    Valor pago neste meio.

    ativoboolean

    Indica se o pagamento está ativo no pré-documento.

  • ]
  • cliente object
    oneOf
    null
  • ]
  • paginaAtualinteger<int32>obrigatório

    Número da página devolvida, começando em 1.

    tamanhoPaginainteger<int32>obrigatório

    Quantos itens cabem em uma página, já limitado ao máximo do endpoint.

    totalItensinteger<int32>obrigatório

    Total de itens que a consulta encontrou, em todas as páginas.

    totalPaginasinteger<int32>

    Total de páginas para este tamanho de página.

    temProximaboolean

    Verdadeiro enquanto houver página seguinte.

    sucessoboolean

    Verdadeiro quando a operação foi atendida. Falso vem sempre com a causa em mensagens.

    mensagensstring[]anulável

    Textos para o integrador: a causa de uma recusa, ou um aviso em caso de sucesso.

    ResultadoOfPaginaOfPedidoResponse
    {
    "dados": {
    "itens": [
    {
    "protocolo": 0,
    "chavePedidoEcommerce": "null",
    "filial": 0,
    "operacao": 0,
    "operacaoDescricao": "null",
    "dataEmissao": "2024-07-29T15:51:28.071Z",
    "status": 20,
    "statusDescricao": "null",
    "idEnvioEcommerce": "null",
    "valorSubTotal": 0,
    "valorSubTotalItens": 0,
    "valorDescontoItens": 0,
    "valorAcrescimoItens": 0,
    "valorTotalItens": 0,
    "valorFrete": 0,
    "valorTotal": 0,
    "valorCusto": 0,
    "percentualLucro": 0,
    "observacao": "null",
    "ativo": true,
    "itens": [
    {
    "numeroItem": 0,
    "produto": "null",
    "descricao": "string",
    "quantidade": 0,
    "valorUnitario": 0,
    "valorSubTotal": 0,
    "valorDesconto": 0,
    "valorAcrescimo": 0,
    "valorTotal": 0,
    "valorDescontoRateado": 0,
    "valorAcrescimoRateado": 0,
    "valorFreteRateado": 0,
    "valorLiquido": 0,
    "valorCusto": 0,
    "percentualLucro": 0,
    "tabelaPreco": 0,
    "promocao": true,
    "ativo": true
    }
    ],
    "pagamentos": [
    {
    "meioPagamento": 1,
    "meioPagamentoDescricao": "null",
    "valor": 0,
    "ativo": true
    }
    ],
    "cliente": "null"
    }
    ],
    "paginaAtual": 0,
    "tamanhoPagina": 0,
    "totalItens": 0,
    "totalPaginas": 0,
    "temProxima": true
    },
    "sucesso": true,
    "mensagens": "null"
    }