API Documentation

The José Madrid Salsa platform provides comprehensive REST API endpoints for integration with external systems and mobile applications.

Authentication

All API requests require proper authentication. See API Authentication for details.

Available Endpoints

Products API

• GET /api/products - List all products
• GET /api/products/:id - Get product details
• POST /api/admin/products - Create product (admin)
• PATCH /api/admin/products/:id - Update product (admin)
• DELETE /api/admin/products/:id - Delete product (admin)

Orders API

• GET /api/orders - List user orders
• GET /api/orders/:orderId - Get order details
• POST /api/orders - Create new order
• POST /api/admin/orders/:id/update-status - Update order status (admin)

Account API

• GET /api/account - Get current user profile
• GET /api/account/addresses / POST /api/account/addresses - List or add saved addresses
• POST /api/auth/forgot-password / POST /api/auth/reset-password - Password reset

Locations API

• GET /api/locations - List store locations (pass lat, lng and sort=distance for nearest first)

Shopping Cart API

• GET /api/cart - Get current cart
• POST /api/cart - Add item to cart
• PUT /api/cart/:id - Update cart item quantity
• DELETE /api/cart/:id - Remove item from cart
• POST /api/checkout - Initiate checkout

Response Format

All responses follow a standard format:

{
  "success": true,
  "data": {
    // Response data
  },
  "error": null,
  "meta": {
    "total": 100,
    "page": 1,
    "limit": 10
  }
}

Error Handling

See Error Responses for comprehensive error handling information.

Rate Limiting

The API implements rate limiting. See Rate Limiting for details.

Inbound Webhooks

Five providers post events back to the platform. See Webhooks for each endpoint, how it verifies its sender, and what it changes.

Full Endpoint Reference

REST API documents the endpoint surface in detail. Route handlers live in apps/storefront/app/api — roughly fifty route groups, all deployed with the storefront.