Pular para o conteúdo principal

CriarPedidoCommand

Um pedido vindo da plataforma de e-commerce.

chavePedidoEcommercestring

Identificador do pedido na plataforma. É a chave que evita receber duas vezes.

dataEmissao(null | string)<date-time>anulável

Data em que o pedido foi fechado na loja.

statusnull | integeranulável

Situação do pedido, na numeração de status do ERP. Valores: 20 = PEDIDO AGUARDANDO PAGTO; 21 = PEDIDO EFETUADO; 22 = PEDIDO PAGO; 23 = PEDIDO EM SEPARAÇÃO; 24 = PEDIDO EM PRODUÇÃO; 25 = PEDIDO PRONTO PARA RETIRADA; 26 = PEDIDO ENVIADO; 27 = PEDIDO ENTREGUE; 28 = PEDIDO CANCELADO.

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

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

Identificador do envio na plataforma, quando existir.

observacaonull | stringanulável

Observação livre, que aparece no pré-documento do ERP.

valorSubTotalnumber<double>

Soma dos itens antes de desconto, acréscimo e frete.

valorDescontoItensnumber<double>

Desconto concedido sobre os itens.

valorAcrescimoItensnumber<double>

Acréscimo aplicado sobre os itens.

valorFretenumber<double>

Frete do pedido. Deve estar rateado entre os itens.

valorTotalnumber<double>

Valor total do pedido. A soma do líquido dos itens tem de bater com ele.

cliente object
oneOf
null
itens object[]

Os itens do pedido. Ao menos um.

  • Array [
  • numeroIteminteger<int32>

    Número do item dentro do pedido, começando em 1.

    produtoIdinteger<int64>

    Código do produto no ERP.

    descricaonull | stringanulável

    Descrição do item, como a loja a exibiu.

    grade(null | integer)<int32>anulável

    Código numérico da grade vendida, o grades[].codigo de /produtos, não o nome.

    cor(null | integer)<int32>anulável

    Código numérico da cor vendida, o grades[].cores[].codigo de /produtos, não o nome. Obrigatório quando a grade vendida tem cores ativas; sem cores, não informe.

    quantidadenumber<double>

    Quantidade vendida. Maior que zero.

    valorUnitarionumber<double>

    Preço unitário praticado na loja. Não pode ser negativo.

    valorSubTotalnumber<double>

    Quantidade × valor unitário, antes de rateios.

    valorDescontonumber<double>

    Desconto próprio do item, sem o rateio do pedido.

    valorAcrescimonumber<double>

    Acréscimo próprio do item, sem o rateio do pedido.

    valorTotalnumber<double>

    Valor do item após desconto e acréscimo próprios, sem os rateios do pedido.

    valorDescontoRateadonumber<double>

    Parcela do desconto do pedido rateada neste item.

    valorAcrescimoRateadonumber<double>

    Parcela do acréscimo do pedido rateada neste item.

    valorFreteRateadonumber<double>

    A parte do frete do pedido que cabe a este item.

    valorLiquidonumber<double>

    O que o item vale depois dos rateios.

    tabelaPrecointeger<int32>

    Código da tabela de preço usada, como em /tabelas-preco.

    percentualLucronumber<double>

    Percentual de lucro calculado pela loja. Informativo; o ERP não recalcula.

    valorCustonumber<double>

    Custo do item conhecido pela loja. Informativo; o ERP não recalcula.

    promocaoboolean

    Se o item saiu em promoção.

  • ]
  • pagamentos object[]

    As formas de pagamento. Ao menos uma.

  • 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]

    valornumber<double>

    Valor pago neste meio. Maior que zero.

    descricaonull | stringanulável

    Texto livre do meio de pagamento. Omitido, vale a descrição padrão do ERP.

  • ]
  • CriarPedidoCommand
    {
    "chavePedidoEcommerce": "string",
    "dataEmissao": "null",
    "status": 20,
    "idEnvioEcommerce": "null",
    "observacao": "null",
    "valorSubTotal": 0,
    "valorDescontoItens": 0,
    "valorAcrescimoItens": 0,
    "valorFrete": 0,
    "valorTotal": 0,
    "cliente": "null",
    "itens": [
    {
    "numeroItem": 0,
    "produtoId": 0,
    "descricao": "null",
    "grade": "null",
    "cor": "null",
    "quantidade": 0,
    "valorUnitario": 0,
    "valorSubTotal": 0,
    "valorDesconto": 0,
    "valorAcrescimo": 0,
    "valorTotal": 0,
    "valorDescontoRateado": 0,
    "valorAcrescimoRateado": 0,
    "valorFreteRateado": 0,
    "valorLiquido": 0,
    "tabelaPreco": 0,
    "percentualLucro": 0,
    "valorCusto": 0,
    "promocao": true
    }
    ],
    "pagamentos": [
    {
    "meioPagamento": 1,
    "valor": 0,
    "descricao": "null"
    }
    ]
    }