TypeScript modules
CargoClient exposes one client per area. Method names are camelCase; each maps to one endpoint.
client.orderV3
| Method | Endpoint | Purpose |
|---|---|---|
createOrder(body) | POST /v3/order-create | Create an order and request a courier. |
validateOrder(body) | POST /v3/order-validate | Check coverage, time and availability without creating. |
cancelOrder(body) | POST /v3/order-cancel | Cancel while created, in progress or in store. |
getOrderStatus(body) | POST /v3/order-status | Current state of an order. |
listOrders() | GET /v3/order/list | Orders of the token's account. |
getOrderCreationBody({ rappi_order_id }) | GET /v3/order-creation-body/{rappi_order_id} | Body that created an order, ready for createOrder to duplicate it. |
markOrderReady({ rappi_order_id }) | POST /v3/order-ready/{rappi_order_id} | Signal the order is ready for pickup. |
client.pickingPoints
| Method | Endpoint | Purpose |
|---|---|---|
createPickingPoint(body) | POST /picking-point | Register a store. |
updatePickingPoint(body) | PUT /picking-point | Update a store. |
deletePickingPoint({ id }) | DELETE /picking-point | Remove a store. |
listPickingPoints({ offset, limit }) | GET /picking-point/list | Paginated list. |
findNearbyPickingPoints({ lat, lng }) | GET /picking-point/nearby | The nearest stores to a coordinate. |
getPickingPoint(id) | GET /picking-point/view/{id} | One store. |
getCheckinCode(pickingPointId) | GET /picking-point/checkin | Checkin code of one store. |
getAllCheckinCodes() | GET /picking-point/list/checkin-code | Checkin codes of all stores. |
refreshCheckinCode({ p }) | POST /picking-point/checkin-refresh | Rotate a store's checkin code. |
client.users
| Method | Endpoint |
|---|---|
createUser(body) | POST /user/create |
updateUser(body) | PUT /user/update |
deleteUser({ id }) | POST /user/delete |
listUsers({ offset, limit }) | GET /user/list (defaults: offset 0, limit 50) |
getUser({ id }) | GET /user/view/{id} |
client.authorization
| Method | Endpoint | Purpose |
|---|---|---|
listPermissionGroups() | GET /authorization/permission-group/list | Roles available for your account. Use an id as permission_group_id when creating a user. |
client.rt
| Method | Endpoint | Purpose |
|---|---|---|
confirmOrderReturn({ rappi_order_id }) | POST /rt/remove-debt/{rappi_order_id} | Confirm that an order was returned to the store (also clears the courier's debt). |
Renamed in 0.2.0
Version 0.1.0 exposes this method as removeDebt. From 0.2.0 it is confirmOrderReturn: same
endpoint, same request, new name. Upgrade with npm install @rappi_cargo/cargo-core-api-sdk@latest.
Types
Request and response types are exported alongside the clients, so you can reference them in your
own code (for example OrderCreateV3ReqDtoFixed, PickingPointResDTOFixed). Your editor shows
them on hover, and they are the source of truth for required and optional fields.