Welcome! Human interface is WIP. Check out wireframes and future API development plans at github repo.

To use the API now...

Browse and Create

To view, filter, create, and edit store inventories of Coke flavors while I work on this interface,

visit the Django REST Framework browsable API.

API Endpoints

Retailers

  • GET /api/retailers/ - retrieve all retailers
  • GET /api/retailers/:retailer_id/ - retrieve specific retailer
  • GET /api/retailers/:retailer_id/sodas/ - retrieve all retailers with specific soda
  • GET /api/retailers/?postcode=:retailer_postcode - retrieve all retailers with specific postcode; e.g. "www.findcokezero.com/api/retailers/?postcode=11111"
  • GET /api/retailers/?postcode=:retailer_postcode&sodas=:soda_abbreviations - retrieve all retailers with specific postcode and selection of soda types
  • POST /api/retailers/ - create retailer
  • PATCH /api/retailers/:retailer_id/ - edit retailer
  • DELETE /api/retailers/:retailer_id/ - remove retailer

Sodas

  • GET /api/sodas/ - retrieve all sodas
  • GET /api/sodas/:soda_id/ - retrieve specific soda
  • GET /api/sodas/:soda_id/retailers/ - retrieve all sodas at specific retailer
  • POST /api/sodas/ - create soda
  • PATCH /api/sodas/:soda_id/ - edit soda
  • DELETE /api/sodas/:soda_id/ - remove soda