v1

latestOpenAPI 3.1.02026-08-044330906.8 KB

Insere um novo pedido

Caso a loja utilize as formas de pagamento do gateway o campo "formaPagamentoId" do objeto "pagamento" deverá conter o valor "200".

post/pedidos

Request body

pedidoIdinteger

Id do pedido que está sendo inserido. Caso seja informado deve ser um Id disponível na loja. Caso não seja informado, um Id será gerado (optional)

carrinhoIdstring

Id do carrinho que foi utilizado no pedido (optional)

situacaoPedidoIdinteger required

Define em qual situação está o pedido. A lista completa das possíveis situações se encontra no GET /situacoesPedido

datastring date required

Data em que o pedido foi realizado

valorTotalnumber double required

Valor total do pedido. Se informado deve ser igual a soma de todos os valores inclusos no pedido (preços dos produtos, ajustes, frete, etc) (optional)

valorJurosnumber double required

Informação do juros do pedido

valorDescontonumber double required

Informação de desconto do pedido

usuarioIdinteger

Id do usuário que realizou a compra. É possível recuperar o Id de um usuário no GET /usuarios

enderecoIdinteger

Id do endereço do usuário que deve ser utilizado como endereço de entrega. Para buscar os endereços de um usuário utilize o GET /usuarios/{usuarioId}/enderecos

isMobileboolean required

Define se o pedido foi feito através de um dispositivo móvel ou não

eventoIdinteger

Id do evento ao qual o pedido está vinculado (opcional)

canalIdinteger

ParceiroId vinculado ao pedido (optional)

transacaoIdinteger

Id da transação (optional)

observacaostring

Observação do pedido (optional)

validoboolean

Se um pedido é valido (optional)

cupomDescontostring

Cupom de desconto (optional)

ipstring

IP da criação do pedido (optional)

usuarioMasterinteger

ID do usuário master que realizou o pedido, se houver (optional)

retiradaLojaIdinteger

Id da loja física na qual o pedido será retirado (optional)

Response

201