API & Webhooks

Your system handles sales.
Keep deliveries connected.

Take orders from your ERP, e-commerce or own system to Entregui. Get delivery progress back and reduce the work of updating everything by hand.

Explore an integrated order
REST/JSONAPI v2Webhooks
A connected operationFROM ORDER TO DELIVERY
ERP E-commerce Your system
Requests via API
Entregui

Organizing orders
to confirm delivery.

Routes Delivery man Tracking
The information comes back to youStatus, occurrences and evidence
WEBHOOKS
order.deliveredOrder delivered

Fewer tasks between systems

The sale doesn't have to end
in a delivery spreadsheet.

Connect the information created in your business to the operation that takes the order to the customer.

Reduce retyping

Send the order data through the integration and avoid repeating registrations and addresses during the delivery operation.

Give context to the service

Use status, tracking and incidents so your team responds to the customer with delivery information.

Close the loop on your system

Receive confirmation and consult evidence to feed your service and after-sales processes.

Explore the flow

A request. Information
in both directions.

Choose a stage and see what happens in the operation and what your integration can achieve.

Order PED-100045Interactive example · dummy data
01 / ORDER CREATED

The order enters without retyping.

Your system sends data through the API. Entregui creates the order as pending, ready to enter planning.

PED-100045Your reference, also on Entregui
Pending
Your system → Entregui

Save the returned ID or use the external reference to reference this order in the next steps.

Integration visionJSON

POST /api/v2/orders

Answer 201 · selected fields
{
  "order": {
    "id": 123,
    "custom_id": "PED-100045",
    "status": "PENDING"
  }
}
See the complete example in the documentation

An integration that accompanies the operation

From order registration
to proof of delivery.

Choose the features that make sense for your flow and expand integration as your operation evolves.

Orders and references

Create and consult orders also using your system identifier, maintaining the relationship between the two platforms.

API requests

Operational adjustments

Check status and perform actions such as rescheduling, putting on hold or canceling, according to the rules for each stage.

Available actions

Routes and stops

Consult the planning, orders linked to the route and the sequence of stops to provide visibility into your system.

Route queries

Tracking and occurrences

Monitor tracking data and consult order events and occurrences to guide service.

Tracking data

Events via webhooks

Register a receiving address and select the events that your system should receive, such as output for delivery and completion.

Configure webhooks

Evidence and proof

Consult photos, signatures, files and PDF proof of orders delivered, according to the evidence collected.

Consult evidence

For the technology team

A clear path
to start.

Documentation with endpoints, fields, request examples and responses to guide implementation.

Open documentation
  1. 01

    Connect with company key

    The integration uses an API key tied to the company. Authenticated calls come from your backend.

  2. 02

    Map and validate an order

    List the external identifier, base, recipient and address. Check the API fields and responses.

  3. 03

    Connect operation return

    Register your webhooks receiver and handle the events. Use status and evidence queries to complete the flow.

Before integrating

Frequently asked questions

Align the flow with your technology team and those who take care of deliveries.

Can I connect my ERP or e-commerce?

Yes, through an integration developed with the API. Your system needs to be able to make HTTP calls and, to receive webhooks, provide a receiving address. Talk to your team or supplier to define the implementation.

What is the difference between API and webhook?

In the API, your system initiates a call to send or query information. In the webhook, Entregui sends an event to the address you registered. The two resources can work together in the same flow.

Can I use my system order number?

Yes. The custom_id field allows you to register your external reference and consult the order using it, maintaining correspondence with the Entregui identifier.

Can I recover the photos and proof?

Yes. The API offers evidence queries, files and PDF receipts for delivered orders. The content available depends on what was collected in the delivery confirmation.

How is the integration authenticated?

Calls use an API key linked to the company. Webhooks also have a signature for verification at the receiver. Consult the documentation and maintain the credentials in the backend of the integration.

Connect the next stage of your business

Your order is already in the system.
Take delivery to the same flow.

Show how your operation works today. Our team helps identify integration points with Entregui.