POST – PEDIDO DE VENDA

O pedido de venda realizado em sua loja virtual deverão ser enviados através dessa chamada. Com isso, o pedido de venda da sua loja virtual será cadastrado automaticamente para dentro do Hiper.

Para o consumo da chamada, você deve utilizar o seguinte endereço:

Parâmetros a serem passados na chamada:

Authorization:

  • Deverá ser passado o Bearer Token de autenticação.

Parâmetros a serem enviados na chamada:

cliente // documento:

  • O número do documento da pessoa física ou pessoa jurídica.
  • Tipo do campo: numérico com até 14 caracteres.
    • Deverá ser enviado o documento sem formatação, ou seja, sem caracteres especiais.
      • Se for enviado 14 caracteres será considerado pessoa jurídica.
      • Se for enviado 11 caracteres será considerado pessoa física.
  • O número do documento é uma informação obrigatória.

cliente // email:

  • O endereço de e-mail do cliente.
  • Tipo do campo: string com até 80 caracteres.
  • O endereço de e-mail é uma informação obrigatória.

cliente // inscricaoEstadual:

  • A número da inscrição estadual da pessoa física ou jurídica.
  • Tipo do campo: numérico com até 14 caracteres.
    • Deverá ser enviado o documento sem formatação, ou seja, sem caracteres especiais.

cliente // nomeDoCliente:

  • O nome completo do cliente ou razão social da empresa.
  • Tipo do campo: string com até 80 caracteres.
  • O nome do cliente ou razão social da empresa é uma informação obrigatória.

cliente // nomeFantasia:

  • O nome fantasia da pessoa jurídica.
  • Tipo do campo: string com até 60 caracteres.
  • O nome fantasia da empresa é uma informação obrigatória para pessoa jurídica.

enderecoDeCobranca // bairro:

  • O bairro do endereço de cobrança do cliente.
  • Tipo do campo: string com até 60 caracteres.
  • O bairro do endereço de cobrança do cliente é uma informação obrigatória.

enderecoDeCobranca // cep:

  • O CEP do endereço de cobrança do cliente.
  • Tipo do campo: string com 8 caracteres.
    • Deverá ser enviado o documento sem formatação, ou seja, sem caracteres especiais.
  • O CEP do endereço de cobrança é uma informação obrigatória.

enderecoDeCobranca // codigoIbge:

  • O código do IBGE da cidade do endereço de cobrança do cliente (mais informações disponível em: https://www.ibge.gov.br/explica/codigos-dos-municipios.php).
  • Tipo do campo: numérico com 7 caracteres.
  • O código do IBGE da cidade do endereço de cobrança do cliente é uma informação obrigatória.

enderecoDeCobranca // complemento:

  • O complemento do endereço de cobrança do cliente.
  • Tipo do campo: string com até 60 caracteres.

enderecoDeCobranca // logradouro:

  • O endereço de cobrança do cliente.
  • Tipo do campo: string com até 60 caracteres.
  • O endereço de cobrança do cliente é uma informação obrigatória.

enderecoDeCobranca // numero:

  • O número do endereço de cobrança do cliente.
  • Tipo do campo: string com até 10 caracteres.
  • O número do endereço de cobrança do cliente é uma informação obrigatória.

enderecoDeEntrega // bairro:

  • O bairro do endereço de entrega do cliente.
  • Tipo do campo: string com até 60 caracteres.
  • O bairro do endereço de entrega  é uma informação obrigatória.

enderecoDeEntrega // cep:

  • O CEP do endereço de entrega do cliente.
  • Tipo do campo: string com 8 caracteres.
    • Deverá ser enviado o documento sem formatação, ou seja, sem caracteres especiais.
  • O CEP do endereço de entrega é uma informação obrigatória.

enderecoDeEntrega // codigoIbge:

  • O código do IBGE da cidade do endereço de entrega do cliente (mais informações disponível em: https://www.ibge.gov.br/explica/codigos-dos-municipios.php).
  • Tipo do campo: numérico com 7 caracteres.
  • O código do IBGE da cidade do endereço de entrega do cliente é uma informação obrigatória.

enderecoDeEntrega // complemento:

  • O complemento do endereço de entrega do cliente.
  • Tipo do campo: string com até 60 caracteres.

enderecoDeEntrega // logradouro:

  • O endereço de entrega do cliente.
  • Tipo do campo: string com até 60 caracteres.
  • O endereço de entrega do cliente é uma informação obrigatória.

enderecoDeEntrega // numero:

  • O número do endereço de entrega do cliente.
  • Tipo do campo: string com até 10 caracteres.
  • O número do endereço de entrega do cliente é uma informação obrigatória.

itens // produtoId:

  • O identificador único do produto utilizado na venda.
    • Deverá ser enviado a identificação única utilizada no Hiper.
    • Somente serão aceitos produtos cadastrados/originados do Hiper!
  • Tipo do campo: uniqueidentifier com 36 caracteres.
  • O produto utilizado na venda é uma informação obrigatória.

itens // quantidade:

  • A quantidade do produto utilizado na venda.
  • Tipo do campo: decimal (13,3).
  • A quantidade enviada deverá ser maior que 0.
  • Valor mínimo: 0.001 // Valor máximo: 9999999999999.999.

itens // precoUnitarioBruto:

  • O valor bruto do produto utilizado na venda do e-commerce.
  • Tipo do campo: decimal (12,2).
  • A quantidade enviada deverá ser maior que 0.
  • Valor: mínimo: 0.01 // Valor máximo: 999999999999.99.

itens // precoUnitarioLiquido:

  • O valor líquido do produto utilizado na venda do e-commerce.
    • Se o produto tiver um desconto, o preço líquido deverá ser menor que o bruto.
    • Se o produto tiver um acréscimo, o preço líquido deverá ser maior que o bruto.
    • Se o produto produto não houver acréscimo ou desconto, o preço líquido deverá ser o mesmo do bruto.
  • Tipo do campo: decimal (12,2).
  • A quantidade enviada deverá ser maior que 0.
  • Valor: mínimo: 0.01 // Valor máximo: 999999999999.99.
  • Observação: Deverá ser enviado o valor unitário do produto, a multiplicação do total, ocorrerá de acordo com a quantidade.

meiosDePagamento // idMeioDePagamento:

  • O identificador do meio de pagamento da venda.
  • Tipo do campo: numérico com até 2 caracteres.
  • Boleto: 1 // Cartão de crédito: 4 // Cartão de débito: 5

meiosDePagamento // parcelas:

  • A quantidade de parcelas da venda.
  • Tipo do campo: numérico com até 2 caracteres.
  • A quantidade de parcelas enviada deverá ser maior que 0.
  • Se a venda realiza for à vista, deverá ser enviado como 1.

meiosDePagamento // valor:

  • O valor total líquido da venda.
  • Tipo do campo: decimal (12,2).
  • A quantidade enviada deverá ser maior que 0.
  • Valor mínimo: 0.01 // Valor Máximo: 999999999999.99.

numeroPedidoDeVenda:

  • O número do pedido de venda no e-commerce.
  • Tipo do campo: string com até 20 caracteres.
  • Observação: o pedido não será criado com esse número, apenas estará disponível para buscas nos pedidos de venda no Hiper.

observacaoDoPedidoDeVenda:

  • A observação do pedido de venda no e-commerce.
  • Tipo do campo: string com até 100 caracteres.

valorDoFrete:

  • O valor do frete aplicado na venda.
  • Tipo do campo: decimal (12,2).
  • Valor mínimo: 0.01 // Valor Máximo: 999999999999.99.

Marketplace// CNPJ:

  • CNPJ da Loja virtual que você está utilizando;
  • Tipo do campo: numérico com até 14 caracteres.
  • Campo Opcional de envio.
  • Deve ser informado o campo, caso o estabelecimento seja do estado de SC;

Marketplace// Nome:

  • Nome da Loja virtual que você está utilizando;
  • Tipo do campo: string com até 44 caracteres.
  • Campo Opcional de envio.
  • Deve ser informado o campo, caso o estabelecimento seja do estado de SC;

 

Exemplo de requisição:

{

“cliente”:

{

“documento”: “19561920000”,

“email”: “clientedoecommerce@hotmail.com.br”,

“inscricaoEstadual”: “”,

“nomeDoCliente”: “Cliente do E-commerce”,

“nomeFantasia”: “”

},

“enderecoDeCobranca”: 

{

“bairro”: “Centro”,

“cep”: “88351001”,

“codigoIbge”: 4202909,

“complemento”: “”,

“logradouro”: “Rua Principal”,

“numero”: “01”

},

“enderecoDeEntrega”: 

{

“bairro”: “Centro”,

“cep”: “88351001”,

“codigoIbge”: 4202909,

“complemento”: “Sala 2”,

“logradouro”: “Rua Principal”,

“numero”: “22”

},

“itens”: 

[

{

“produtoId”: “34852cf6-f222-4d61-86d1-045a1aee66f4”,

“quantidade”: 1,

“precoUnitarioBruto”: 99.99,

“precoUnitarioLiquido”: 99.99

}

],

“meiosDePagamento”:

[

{

“idMeioDePagamento”: 1,

“parcelas”: 1,

“valor” : 99.99

}

]

  “numeroPedidoDeVenda”:””,

  “observacaoDoPedidoDeVenda”:””,

  “valorDoFrete”: 0

“Marketplace”: {
“Cnpj”:”12605982000124″,
“Nome”:”Hiper”
}

}

 

Exemplo de resposta:

{

“id”: “158b044b-d887-4e47-b08c-e2b353b1c1d5”,

“errors”: [ ],

“message”: “Pedido recebido e em processamento.”

}