Pular para o conteúdo principal
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>",
  "netValue": 123,
  "grossValue": 123,
  "status": "<string>",
  "quantity": 123,
  "paymentType": "<string>",
  "customerEmail": "<string>",
  "date": "2023-12-25",
  "orderCreatedAt": "2023-11-07T05:31:56Z",
  "products": [
    {
      "productId": "<string>",
      "name": "<string>",
      "quantity": 123,
      "netValue": 123,
      "grossValue": 123,
      "priceCost": 123
    }
  ],
  "utm_source": "<string>",
  "utm_campaign": "<string>",
  "utm_medium": "<string>",
  "utm_content": "<string>",
  "utm_term": "<string>",
  "priceCost": 123
}
'
Use esta rota para enviar informações de vendas para a Nemu.

​
Exemplo (único produto):

{
  "name": "Nome do produto",
  "transactionId": "123",
  "netValue": 10,
  "grossValue": 30,
  "status": "paid",
  "quantity": 1,
  "paymentType": "pix",
  "utm_campaign": "opcional",
  "utm_content": "opcional",
  "utm_medium": "opcional",
  "utm_source": "opcional",
  "utm_term": "opcional",
  "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",
  "netValue": 20,
  "grossValue": 40,
  "status": "paid",
  "quantity": 1,
  "paymentType": "pix",
  "utm_campaign": "opcional",
  "utm_content": "opcional",
  "utm_medium": "opcional",
  "utm_source": "opcional",
  "utm_term": "opcional",
  "customerEmail": "emaildocliente@gmail.com",
  "date": "2024-06-25",
  "createdAt": "2024-06-25 00:00:00",
  "products": [
    {
      "productId": "1",
      "name": "Nome do Produto 1",
      "quantity": 1,
      "netValue": 10,
      "grossValue": 20,
      "priceCost": 5,
      "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

​
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 (pix, billet, credit_card, other)

​
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<date-time>
obrigatório

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

​
products
object[]
obrigatório

Lista de produtos do pedido

​
utm_source
string

Parâmetro utm_source (opcional)

​
utm_campaign
string

Parâmetro utm_campaign (opcional)

​
utm_medium
string

Parâmetro utm_medium (opcional)

​
utm_content
string

Parâmetro utm_content (opcional)

​
utm_term
string

Parâmetro utm_term (opcional)

​
priceCost
number

Preço de custo do produto/pedido

Resposta

Venda criada com sucesso.