Docs
API Modules HTTP Methods Status Codes

Users
Sign In Sign Out Add User Search Users Get My Profile Get A Single User Get My Shopping List Follow User Unfollow User Get My Followers Get My Following Get User Followers Get User Following Edit User Report User Remove User
Groceries
Add Grocery Search Groceries Get Grocery Edit Grocery Add Grocery To Shopping List Remove Grocery From Shopping List Report Grocery Remove Grocery
Recipes
Add Recipe List My Recipes List User Recipes Search Recipes Get Recipe Favorite A Recipe Unfavorite A Recipe Get My Favorites Edit Recipe Comment Recipe Get Recipe Comments Report Recipe Remove Recipe
Restaurants
Add Restaurant Search Restaurants Get Restaurant Edit Restaurant Order Recipe Comment Restaurant Get Comments Report Restaurant Remove Restaurant
Stores
Add Store Search Stores Get Store Edit Store Order Grocery Comment Store Report Store Remove Store
Orders
List My Orders List Store Orders List Restaurant Orders Get Order Edit Order Remove Order
Badges
Search Badges

Groceries - API Documentation

Your favourite grocery stores came online !

Add grocery

Adds grocery to the system.

POST
/groceries

Parameters
access_token String A valid access token.
title String Title of grocery.
description String Brief description of grocery.
also_known_as String Alternate name of grocery.
cover file Image of grocery.
metric_units [String] Unit of grocery.
categories [String] Grocery categories.
Response 
Status: 201

Search groceries

Search for groceries.

GET
/groceries

Parameters
access_token String A valid access token.
title String Title of the grocery.
categories String Catogory name to be searched.
Response 
[
    {
        "_id": "afohre57njhsdgg6736123sd",
        "title": "Potato",
        "description": "Light brown color veg.",
        "also_known_as": "",
        "cover": "afohre57njhsdgg6736123sd-grocery-cover.jpg",
        "metric_units": [
            "kilogram",
            "gram"
        ],
        "categories": [
            "vegetables"
        ]
    }
]

Get grocery

Get the details of a grocery.

GET
groceries/:grocery_id/

Parameters
access_token String A valid access token.
Response 
{
    "_id": "afohre57njhsdgg6736123sd",
    "title": "Potato",
    "description": "Light brown color veg.",
    "also_known_as": "",
    "cover": "afohre57njhsdgg6736123sd-grocery-cover.jpg",
    "metric_units": [
        "kilogram",
        "gram"
    ],
    "categories": [
        "vegetables"
    ]
}

Edit grocery

Update the grocery with new data.

PATCH
/groceries

Parameters
access_token String A valid access token.
title String Title of grocery.
description String Brief description of grocery.
also_known_as String Alternate name of grocery.
cover file Image of grocery.
metric_units [String] Unit of grocery.
categories [String] Grocery categories.
Response 
Status: 201

Add grocery to shopping list

Brief Description

PUT
groceries/:grocery_id

Parameters
access_token String A valid access token.
Response 
Status: 201

Remove grocery from shopping list

Brief Description

DELETE
/groceries/:grocery_id/

Parameters
access_token String A valid access token.
Response 
Status: 204

Report grocery

Reports a grocery item.

PUT
/groceries/:grocery_id

Parameters
access_token String A valid access token.
reason_type String Type of the report reason.
reason_type String Body of the report reason.
Response 
Status: 200

Remove grocery

Brief Description

DELETE
/groceries/:grocery_id/

Parameters
access_token String A valid access token.
Response 
Status: 204