Criar Venda

POST

sales

cURL

curl --request POST \
  --url https://developers.nemu.com.br/api/v1/sales \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "transactionId": "<string>",
  "isFromApp": false,
  "netValue": 123,
  "grossValue": 123,
  "status": "<string>",
  "quantity": 123,
  "paymentType": "<string>",
  "customerName": "<string>",
  "customerEmail": "<string>",
  "date": "2023-12-25",
  "orderCreatedAt": "2024-06-25 00:00:00",
  "products": [
    {
      "productId": "<string>",
      "name": "<string>",
      "quantity": 123,
      "netValue": 123,
      "grossValue": 123,
      "priceCost": 123,
      "brand": "Marca X"
    }
  ],
  "utm_source": "<string>",
  "utm_campaign": "<string>",
  "utm_medium": "<string>",
  "utm_content": "<string>",
  "utm_term": "<string>",
  "customerPhone": "<string>",
  "coupons": [
    "CUPOM10"
  ],
  "priceCost": 123
}
'

import requests

url = "https://developers.nemu.com.br/api/v1/sales"

payload = {
    "name": "<string>",
    "transactionId": "<string>",
    "isFromApp": False,
    "netValue": 123,
    "grossValue": 123,
    "status": "<string>",
    "quantity": 123,
    "paymentType": "<string>",
    "customerName": "<string>",
    "customerEmail": "<string>",
    "date": "2023-12-25",
    "orderCreatedAt": "2024-06-25 00:00:00",
    "products": [
        {
            "productId": "<string>",
            "name": "<string>",
            "quantity": 123,
            "netValue": 123,
            "grossValue": 123,
            "priceCost": 123,
            "brand": "Marca X"
        }
    ],
    "utm_source": "<string>",
    "utm_campaign": "<string>",
    "utm_medium": "<string>",
    "utm_content": "<string>",
    "utm_term": "<string>",
    "customerPhone": "<string>",
    "coupons": ["CUPOM10"],
    "priceCost": 123
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    transactionId: '<string>',
    isFromApp: false,
    netValue: 123,
    grossValue: 123,
    status: '<string>',
    quantity: 123,
    paymentType: '<string>',
    customerName: '<string>',
    customerEmail: '<string>',
    date: '2023-12-25',
    orderCreatedAt: '2024-06-25 00:00:00',
    products: [
      {
        productId: '<string>',
        name: '<string>',
        quantity: 123,
        netValue: 123,
        grossValue: 123,
        priceCost: 123,
        brand: 'Marca X'
      }
    ],
    utm_source: '<string>',
    utm_campaign: '<string>',
    utm_medium: '<string>',
    utm_content: '<string>',
    utm_term: '<string>',
    customerPhone: '<string>',
    coupons: ['CUPOM10'],
    priceCost: 123
  })
};

fetch('https://developers.nemu.com.br/api/v1/sales', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://developers.nemu.com.br/api/v1/sales",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'transactionId' => '<string>',
    'isFromApp' => false,
    'netValue' => 123,
    'grossValue' => 123,
    'status' => '<string>',
    'quantity' => 123,
    'paymentType' => '<string>',
    'customerName' => '<string>',
    'customerEmail' => '<string>',
    'date' => '2023-12-25',
    'orderCreatedAt' => '2024-06-25 00:00:00',
    'products' => [
        [
                'productId' => '<string>',
                'name' => '<string>',
                'quantity' => 123,
                'netValue' => 123,
                'grossValue' => 123,
                'priceCost' => 123,
                'brand' => 'Marca X'
        ]
    ],
    'utm_source' => '<string>',
    'utm_campaign' => '<string>',
    'utm_medium' => '<string>',
    'utm_content' => '<string>',
    'utm_term' => '<string>',
    'customerPhone' => '<string>',
    'coupons' => [
        'CUPOM10'
    ],
    'priceCost' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://developers.nemu.com.br/api/v1/sales"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"transactionId\": \"<string>\",\n  \"isFromApp\": false,\n  \"netValue\": 123,\n  \"grossValue\": 123,\n  \"status\": \"<string>\",\n  \"quantity\": 123,\n  \"paymentType\": \"<string>\",\n  \"customerName\": \"<string>\",\n  \"customerEmail\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"orderCreatedAt\": \"2024-06-25 00:00:00\",\n  \"products\": [\n    {\n      \"productId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"quantity\": 123,\n      \"netValue\": 123,\n      \"grossValue\": 123,\n      \"priceCost\": 123,\n      \"brand\": \"Marca X\"\n    }\n  ],\n  \"utm_source\": \"<string>\",\n  \"utm_campaign\": \"<string>\",\n  \"utm_medium\": \"<string>\",\n  \"utm_content\": \"<string>\",\n  \"utm_term\": \"<string>\",\n  \"customerPhone\": \"<string>\",\n  \"coupons\": [\n    \"CUPOM10\"\n  ],\n  \"priceCost\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://developers.nemu.com.br/api/v1/sales")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"transactionId\": \"<string>\",\n  \"isFromApp\": false,\n  \"netValue\": 123,\n  \"grossValue\": 123,\n  \"status\": \"<string>\",\n  \"quantity\": 123,\n  \"paymentType\": \"<string>\",\n  \"customerName\": \"<string>\",\n  \"customerEmail\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"orderCreatedAt\": \"2024-06-25 00:00:00\",\n  \"products\": [\n    {\n      \"productId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"quantity\": 123,\n      \"netValue\": 123,\n      \"grossValue\": 123,\n      \"priceCost\": 123,\n      \"brand\": \"Marca X\"\n    }\n  ],\n  \"utm_source\": \"<string>\",\n  \"utm_campaign\": \"<string>\",\n  \"utm_medium\": \"<string>\",\n  \"utm_content\": \"<string>\",\n  \"utm_term\": \"<string>\",\n  \"customerPhone\": \"<string>\",\n  \"coupons\": [\n    \"CUPOM10\"\n  ],\n  \"priceCost\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developers.nemu.com.br/api/v1/sales")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"transactionId\": \"<string>\",\n  \"isFromApp\": false,\n  \"netValue\": 123,\n  \"grossValue\": 123,\n  \"status\": \"<string>\",\n  \"quantity\": 123,\n  \"paymentType\": \"<string>\",\n  \"customerName\": \"<string>\",\n  \"customerEmail\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"orderCreatedAt\": \"2024-06-25 00:00:00\",\n  \"products\": [\n    {\n      \"productId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"quantity\": 123,\n      \"netValue\": 123,\n      \"grossValue\": 123,\n      \"priceCost\": 123,\n      \"brand\": \"Marca X\"\n    }\n  ],\n  \"utm_source\": \"<string>\",\n  \"utm_campaign\": \"<string>\",\n  \"utm_medium\": \"<string>\",\n  \"utm_content\": \"<string>\",\n  \"utm_term\": \"<string>\",\n  \"customerPhone\": \"<string>\",\n  \"coupons\": [\n    \"CUPOM10\"\n  ],\n  \"priceCost\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Venda criada com sucesso"
}

{
  "message": "Campo obrigatório ausente ou inválido"
}

Use esta rota para enviar informações de vendas para a Nemu. O campo customerEmail aceita o email em texto puro ou um valor em hash do email (ex: SHA-256). O campo isFromApp é obrigatório e indica se a venda foi realizada no aplicativo (true) ou não (false). O valor padrão é false.

Exemplo (único produto):

{
  "name": "Nome do produto",
  "transactionId": "123",
  "isFromApp": false,
  "netValue": 10,
  "grossValue": 30,
  "status": "paid",
  "quantity": 1,
  "paymentType": "pix",
  "utm_campaign": "string",
  "utm_content": "string",
  "utm_medium": "string",
  "utm_source": "string",
  "utm_term": "string",
  "customerName": "João Silva",
  "customerEmail": "emaildocliente@gmail.com",
  "date": "2024-06-25",
  "orderCreatedAt": "2024-06-25 00:00:00",
  "priceCost": 5
}

Exemplo (múltiplos produtos):

{
  "name": "Nome do pedido",
  "transactionId": "123",
  "isFromApp": false,
  "netValue": 20,
  "grossValue": 40,
  "status": "paid",
  "quantity": 1,
  "paymentType": "pix",
  "utm_campaign": "string",
  "utm_content": "string",
  "utm_medium": "string",
  "utm_source": "string",
  "utm_term": "string",
  "customerName": "João Silva",
  "customerEmail": "emaildocliente@gmail.com",
  "date": "2024-06-25",
  "createdAt": "2024-06-25 00:00:00",
  "coupons": ["CUPOM10"],
  "products": [
    {
      "productId": "1",
      "name": "Nome do Produto 1",
      "quantity": 1,
      "netValue": 10,
      "grossValue": 20,
      "priceCost": 5,
      "brand": "Marca X",
      "category": {
        "id": "15",
        "name": "categoria 1"
      }
    },
    {
      "productId": "2",
      "name": "Nome do Produto 2",
      "quantity": 1,
      "netValue": 10,
      "grossValue": 20,
      "priceCost": 5
    }
  ]
}

Autorizações

Authorization

string

header

obrigatório

Token de API gerado no dashboard. Envie no header Authorization sem 'Bearer'. Exemplo: Authorization: 123456abcdef

Corpo

application/json

Dados da venda ou pedido.

name

string

obrigatório

Nome do produto ou pedido

transactionId

string

obrigatório

ID da transação ou pedido

isFromApp

boolean

padrão:false

obrigatório

Indica se a venda foi originada pelo aplicativo. Valor padrão: false.

netValue

number

obrigatório

Valor líquido da transação ou pedido

grossValue

number

obrigatório

Valor bruto da transação ou pedido

status

string

obrigatório

Status da transação ou pedido (paid, waiting_payment, cancelled, chargeback, refunded, checkout_completed)

quantity

number

obrigatório

Quantidade vendida

paymentType

string

obrigatório

Método de pagamento: billet, credit_card, pix ou others. Atenção ao plural em others — o valor other é rejeitado.

customerName

string

obrigatório

Nome do cliente

customerEmail

string

obrigatório

Email do comprador. Também aceita um valor em hash do email (ex: SHA-256)

date

string<date>

obrigatório

Data de criação do pedido (YYYY-MM-DD)

orderCreatedAt

string

obrigatório

Data e hora de criação do pedido em UTC 0 (YYYY-MM-DD HH:MM:SS)

Exemplo:

"2024-06-25 00:00:00"

products

object[]

obrigatório

Lista de produtos do pedido

Show child attributes

utm_source

string

Parâmetro utm_source

utm_campaign

string

Parâmetro utm_campaign

utm_medium

string

Parâmetro utm_medium

utm_content

string

Parâmetro utm_content

utm_term

string

Parâmetro utm_term

customerPhone

string

Telefone do cliente. Opcional, mas recomendamos o envio.

coupons

string[]

Lista de cupons de desconto aplicados ao pedido (opcional)

Exemplo:

["CUPOM10"]

priceCost

number

Preço de custo do produto/pedido

Resposta

Venda criada com sucesso.

message

string

Exemplo:

"Venda criada com sucesso"

cURL

curl --request POST \
  --url https://developers.nemu.com.br/api/v1/sales \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "transactionId": "<string>",
  "isFromApp": false,
  "netValue": 123,
  "grossValue": 123,
  "status": "<string>",
  "quantity": 123,
  "paymentType": "<string>",
  "customerName": "<string>",
  "customerEmail": "<string>",
  "date": "2023-12-25",
  "orderCreatedAt": "2024-06-25 00:00:00",
  "products": [
    {
      "productId": "<string>",
      "name": "<string>",
      "quantity": 123,
      "netValue": 123,
      "grossValue": 123,
      "priceCost": 123,
      "brand": "Marca X"
    }
  ],
  "utm_source": "<string>",
  "utm_campaign": "<string>",
  "utm_medium": "<string>",
  "utm_content": "<string>",
  "utm_term": "<string>",
  "customerPhone": "<string>",
  "coupons": [
    "CUPOM10"
  ],
  "priceCost": 123
}
'

import requests

url = "https://developers.nemu.com.br/api/v1/sales"

payload = {
    "name": "<string>",
    "transactionId": "<string>",
    "isFromApp": False,
    "netValue": 123,
    "grossValue": 123,
    "status": "<string>",
    "quantity": 123,
    "paymentType": "<string>",
    "customerName": "<string>",
    "customerEmail": "<string>",
    "date": "2023-12-25",
    "orderCreatedAt": "2024-06-25 00:00:00",
    "products": [
        {
            "productId": "<string>",
            "name": "<string>",
            "quantity": 123,
            "netValue": 123,
            "grossValue": 123,
            "priceCost": 123,
            "brand": "Marca X"
        }
    ],
    "utm_source": "<string>",
    "utm_campaign": "<string>",
    "utm_medium": "<string>",
    "utm_content": "<string>",
    "utm_term": "<string>",
    "customerPhone": "<string>",
    "coupons": ["CUPOM10"],
    "priceCost": 123
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    transactionId: '<string>',
    isFromApp: false,
    netValue: 123,
    grossValue: 123,
    status: '<string>',
    quantity: 123,
    paymentType: '<string>',
    customerName: '<string>',
    customerEmail: '<string>',
    date: '2023-12-25',
    orderCreatedAt: '2024-06-25 00:00:00',
    products: [
      {
        productId: '<string>',
        name: '<string>',
        quantity: 123,
        netValue: 123,
        grossValue: 123,
        priceCost: 123,
        brand: 'Marca X'
      }
    ],
    utm_source: '<string>',
    utm_campaign: '<string>',
    utm_medium: '<string>',
    utm_content: '<string>',
    utm_term: '<string>',
    customerPhone: '<string>',
    coupons: ['CUPOM10'],
    priceCost: 123
  })
};

fetch('https://developers.nemu.com.br/api/v1/sales', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://developers.nemu.com.br/api/v1/sales",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'transactionId' => '<string>',
    'isFromApp' => false,
    'netValue' => 123,
    'grossValue' => 123,
    'status' => '<string>',
    'quantity' => 123,
    'paymentType' => '<string>',
    'customerName' => '<string>',
    'customerEmail' => '<string>',
    'date' => '2023-12-25',
    'orderCreatedAt' => '2024-06-25 00:00:00',
    'products' => [
        [
                'productId' => '<string>',
                'name' => '<string>',
                'quantity' => 123,
                'netValue' => 123,
                'grossValue' => 123,
                'priceCost' => 123,
                'brand' => 'Marca X'
        ]
    ],
    'utm_source' => '<string>',
    'utm_campaign' => '<string>',
    'utm_medium' => '<string>',
    'utm_content' => '<string>',
    'utm_term' => '<string>',
    'customerPhone' => '<string>',
    'coupons' => [
        'CUPOM10'
    ],
    'priceCost' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://developers.nemu.com.br/api/v1/sales"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"transactionId\": \"<string>\",\n  \"isFromApp\": false,\n  \"netValue\": 123,\n  \"grossValue\": 123,\n  \"status\": \"<string>\",\n  \"quantity\": 123,\n  \"paymentType\": \"<string>\",\n  \"customerName\": \"<string>\",\n  \"customerEmail\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"orderCreatedAt\": \"2024-06-25 00:00:00\",\n  \"products\": [\n    {\n      \"productId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"quantity\": 123,\n      \"netValue\": 123,\n      \"grossValue\": 123,\n      \"priceCost\": 123,\n      \"brand\": \"Marca X\"\n    }\n  ],\n  \"utm_source\": \"<string>\",\n  \"utm_campaign\": \"<string>\",\n  \"utm_medium\": \"<string>\",\n  \"utm_content\": \"<string>\",\n  \"utm_term\": \"<string>\",\n  \"customerPhone\": \"<string>\",\n  \"coupons\": [\n    \"CUPOM10\"\n  ],\n  \"priceCost\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://developers.nemu.com.br/api/v1/sales")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"transactionId\": \"<string>\",\n  \"isFromApp\": false,\n  \"netValue\": 123,\n  \"grossValue\": 123,\n  \"status\": \"<string>\",\n  \"quantity\": 123,\n  \"paymentType\": \"<string>\",\n  \"customerName\": \"<string>\",\n  \"customerEmail\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"orderCreatedAt\": \"2024-06-25 00:00:00\",\n  \"products\": [\n    {\n      \"productId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"quantity\": 123,\n      \"netValue\": 123,\n      \"grossValue\": 123,\n      \"priceCost\": 123,\n      \"brand\": \"Marca X\"\n    }\n  ],\n  \"utm_source\": \"<string>\",\n  \"utm_campaign\": \"<string>\",\n  \"utm_medium\": \"<string>\",\n  \"utm_content\": \"<string>\",\n  \"utm_term\": \"<string>\",\n  \"customerPhone\": \"<string>\",\n  \"coupons\": [\n    \"CUPOM10\"\n  ],\n  \"priceCost\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developers.nemu.com.br/api/v1/sales")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"transactionId\": \"<string>\",\n  \"isFromApp\": false,\n  \"netValue\": 123,\n  \"grossValue\": 123,\n  \"status\": \"<string>\",\n  \"quantity\": 123,\n  \"paymentType\": \"<string>\",\n  \"customerName\": \"<string>\",\n  \"customerEmail\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"orderCreatedAt\": \"2024-06-25 00:00:00\",\n  \"products\": [\n    {\n      \"productId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"quantity\": 123,\n      \"netValue\": 123,\n      \"grossValue\": 123,\n      \"priceCost\": 123,\n      \"brand\": \"Marca X\"\n    }\n  ],\n  \"utm_source\": \"<string>\",\n  \"utm_campaign\": \"<string>\",\n  \"utm_medium\": \"<string>\",\n  \"utm_content\": \"<string>\",\n  \"utm_term\": \"<string>\",\n  \"customerPhone\": \"<string>\",\n  \"coupons\": [\n    \"CUPOM10\"\n  ],\n  \"priceCost\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Venda criada com sucesso"
}

{
  "message": "Campo obrigatório ausente ou inválido"
}

​Exemplo (único produto):

​Exemplo (múltiplos produtos):

Autorizações

Corpo

Resposta

Exemplo (único produto):

Exemplo (múltiplos produtos):