How to integrate Nemu API

The Nemu API is a tool for interacting with our platform and expanding your application's capabilities. Below, we'll explain how to use the API to send sales events.

Authentication

To authenticate the user, include the dashboard token in the Authorization header of your request.

Generating the User Token

Access the dashboard details.
Click on Settings.

Settings

Go to Nemu API Integration and click Generate API Token.

Generate token

Copy the token displayed.

Copy token

Sending Sales Data to Nemu

The API offers two routes to create and update orders, enabling real-time information sharing with the dashboard.

Base URL for requests:

https://developers.nemu.com.br/api/v1

`POST /sales`

Use this route to submit sales information.

Transaction/Order Parameters

Parameter	Description	Type
`name` *	Product or order name	string
`transactionId` *	Transaction or order ID	string
`netValue` *	Net amount of the transaction or order	number
`grossValue` *	Gross amount of the transaction or order	number
`status` *	Transaction or order status (`paid`, `waiting_payment`, `cancelled`, `chargeback`, `refunded`)	string
`quantity` *	Quantity sold in the transaction or order	number
`paymentType` *	Payment method (`pix`, `billet`, `credit_card`, `other`)	string
`utm_source`	UTM source parameter	string
`utm_campaign`	UTM campaign parameter	string
`utm_medium`	UTM medium parameter	string
`utm_content`	UTM content parameter	string
`utm_term`	UTM term parameter	string
`customerName` *	Buyer's name	string
`customerEmail` *	Buyer's email	string
`customerPhone` *	Buyer's phone number	string
`date` *	Sale date (format: `YYYY-MM-DD`)	string
`orderCreatedAt`	Sale date and time (format: `YYYY-MM-DD HH:MM:SS`)	date
`products`	Product list for the order (use when more than one product is included)	array of products

Product List Parameters

Parameter	Description	Type
`productId` *	Product ID	string
`name` *	Product name	string
`quantity` *	Quantity of product sold	number
`netValue` *	Product net value	number
`grossValue` *	Product gross value	number
`priceCost`	Product cost price	number

Example request for a single product:

{
    "name": "Product name",
    "transactionId": "123",
    "netValue": 10,
    "grossValue": 30,
    "status": "paid",
    "quantity": 1,
    "paymentType": "pix",
    "utm_campaign": "optional",
    "utm_content": "optional",
    "utm_medium": "optional",
    "utm_source": "optional",
    "utm_term": "optional",
    "customerName": "Customer Name",
    "customerEmail": "customeremail@gmail.com",
    "customerPhone": "11912345678",
    "date": "2024-06-25",
    "orderCreatedAt": "2024-06-25 00:00:00",
    "priceCost": 5
}

Example request for multiple products:

{
    "name": "Order name",
    "transactionId": "123",
    "netValue": 20,
    "grossValue": 40,
    "status": "paid",
    "quantity": 1,
    "paymentType": "pix",
    "utm_campaign": "optional",
    "utm_content": "optional",
    "utm_medium": "optional",
    "utm_source": "optional",
    "utm_term": "optional",
    "customerName": "Customer Name",
    "customerEmail": "customeremail@gmail.com",
    "customerPhone": "11912345678",
    "date": "2024-06-25",
    "createdAt": "2024-06-25 00:00:00",
    "products": [
        {
            "productId": "1",
            "name": "Product Name 1",
            "quantity": 1,
            "netValue": 10,
            "grossValue": 20,
            "priceCost": 5
        },
        {
            "productId": "2",
            "name": "Product Name 2",
            "quantity": 1,
            "netValue": 10,
            "grossValue": 20,
            "priceCost": 5
        }
    ]
}

`PUT /sales/:transactionId`

Use this route to update the information of an existing order.

Order Update Parameters

Parameter	Description	Type
`status`	New status of the transaction or order (`paid`, `waiting_payment`, etc.)	string
`customerName`	Updated buyer's name	string
`customerEmail`	Updated buyer's email	string
`customerPhone`	Updated buyer's phone number	string
`date`	New sale date (format: `YYYY-MM-DD`)	string

Example request:

{
    "status": "paid",
    "customerName": "New Customer Name",
    "customerEmail": "newcustomer@gmail.com",
    "customerPhone": "11998765432",
    "date": "2024-06-25"
}

Make sure to include the Authorization header with your API token in all requests.

I hope this clarifies how to use the Nemu API to send sales events!

Atualizado em: 20/06/2025

Este artigo foi útil?

Obrigado!