The Orders API manages the lifecycle of delivery orders from creation through final delivery or cancellation. Orders progress through a strict state machine; some transitions are triggered automatically by the Assignments API. Payments and invoices are attached to an order via sub-resource endpoints documented at the bottom of this page.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/JorLOrT/rappi2/llms.txt
Use this file to discover all available pages before exploring further.
Order state machine
An order always starts inPendiente. From there it advances as drivers are assigned and start their routes, and can be cancelled at any point except when already cancelled.
| State | Description |
|---|---|
Pendiente | Order created, awaiting driver assignment. |
En Proceso | Driver assigned; not yet en route. |
En Tránsito | Driver has started the delivery. |
Entregado | Delivery confirmed complete. |
Cancelado | Order cancelled; terminal state. |
List orders
ordenes:read
Query parameters
Number of records to skip for pagination.
Maximum number of records to return. Hard cap: 200.
Return only orders belonging to this client.
Filter by order state. One of
Pendiente, En Proceso, En Tránsito, Entregado, Cancelado.Response 200
Array of order objects.
Unique order identifier.
ID of the client who placed the order.
Current order state.
Pick-up street address.
Pick-up district.
Delivery street address.
Delivery district.
Order total amount (decimal).
ISO 8601 creation timestamp.
Create an order
Pendiente. The referenced client must be active.
Required permission: ordenes:write
Request body
ID of an active client placing the order.
Pick-up street address.
Pick-up district.
Delivery street address.
Delivery district.
Order total amount.
Response 201
The newly created order object.
Get an order
404 if not found.
Required permission: ordenes:read
Path parameters
Order ID.
Response 200
Order object.
Update an order
estado. Note that normal state transitions are handled automatically by the Assignments API; direct state writes via this endpoint bypass those guard-rails.
Required permission: ordenes:write
Path parameters
Order ID.
Request body
All fields are optional.New state. One of
Pendiente, En Proceso, En Tránsito, Entregado, Cancelado.New pick-up address.
New pick-up district.
New delivery address.
New delivery district.
Updated order total.
Response 200
Updated order object.
Cancel an order
Cancelado. Returns 400 if the order is already cancelled. This is a soft operation — the order record is preserved.
Required permission: ordenes:delete
Path parameters
Order ID.
Response 204
No body.
Payments
Payments are linked to a specific order and track money transfers.List all payments
pagos:read
Pagination offset.
Max records (cap 200).
Filter by payment state:
Pendiente, Pagado, Fallido, or Reembolsado.Only payments on or after this ISO 8601 timestamp.
Only payments on or before this ISO 8601 timestamp.
Create a payment for an order
pagos:write
Order ID.
Payment amount.
Initial state:
Pendiente, Pagado, Fallido, or Reembolsado.Bank reference or transaction ID.
201: created payment object.
Payment ID.
Parent order ID.
Amount paid.
Payment state.
Bank reference.
Timestamp of payment record creation.
List payments for an order
pagos:read
Order ID.
Get a payment
pagos:read
Payment ID.
Update a payment
pagos:write
Payment ID.
New state.
Updated bank reference.
Delete a payment
pagos:delete
Payment ID.
204: no body.
Invoices
Invoices (facturas) are generated for orders and can reference a RUC (tax ID).List all invoices
facturas:read
Pagination offset.
Max records (cap 200).
Filter by tax ID (RUC).
Only invoices on or after this timestamp.
Only invoices on or before this timestamp.
Create an invoice for an order
facturas:write
Order ID.
Invoice amount.
RUC (tax ID) of the billing entity.
URL to the PDF or external invoice document.
201: created invoice object.
Invoice ID.
Parent order ID.
Invoice amount.
Tax ID.
Document URL.
Invoice creation timestamp.
List invoices for an order
facturas:read
Order ID.
Get an invoice
facturas:read
Invoice ID.
Update an invoice
facturas:write
Invoice ID.
New RUC.
Updated amount.
Updated document URL.
Delete an invoice
facturas:delete
Invoice ID.
204: no body.