Stores - API Documentation

Where else you will go to buy ingredients.

Add Store

To add a new store.

POST
/stores

Parameters
access_token String A valid access token.
titleStringName of the store.
taglineStringTagline or Motto of the store.
descriptionStringDescription of the recipe.
logoStringLogo of the Store.
coverImagePhoto of the store.
urlStringHuman friendly URL for the store.
plan_nameStringPlan name of the store.
opening_hours
[
    {
        "open": "Time",
        "close": "Time"
    }
]
payment_methods[String]Lists of payment methods accepted.
can_home_deleverBooleanwhether home delivers food.
adressline1String
addressline2String
landmarkString
stateString
cityString
districtString
countryString
latitudeNumber
longitudeNumber
emailString
phoneString
is_activeBooleanWhether the store is active or not
Response
Status: 201

Search Store

To search the store.

GET
/stores

Parameters
access_token String A valid access token.
Response
[
    {
    "_id": ID,
    "title": String,
    "cover": String,
    "url": String,
    "opening_hours": String,
    "can_home_deliver": Boolean,
    "geo": {
        "latitude": Number,
        "longitude": Number
    },
    "contact": {
        "email": String,
        "phone": String
    }
}
]

Get Store

Get the store.

GET
/stores/:store_id/recipes

Parameters
access_token String A valid access token.
Response
[
    {
    "_id": ID,
    "title": String,
    "tagline": String,
    "description": String,
    "logo": String,
    "cover": String,
    "url": String,
    "opening_hours": String,
    "payment_methods": [String],
    "can_home_deliver": Boolean,
    "badges": [{
        "badge_id": ID,
        "badge_name": String,
        "badge_cover": String,
        "recieved": DateTime
    }],
    "address": {
        "addressLine1": String,
        "addressLine2": String,
        "landmark": String,
        "state": String,
        "city": String,
        "district": String,
        "country": String
    },
    "geo": {
        "latitude": Number,
        "longitude": Number
    },
    "contact": {
        "email": String,
        "phone": String
    },
    "comments": [{
        "user_id": ID,
        "user_avatar": String,
        "user_username": String,
        "user_first_name": String,
        "user_rating": Number,
        "comment": String,
        "rating": Number
    }]
}
]

Edit store

Edit details of store.

PUT
/stores/:store_id

Parameters
access_token String A valid access token.
titleStringName of the store.
taglineStringTagline or Motto of the store.
descriptionStringDescription of the recipe.
logoStringLogo of the Store.
coverImagePhoto of the store.
urlStringHuman friendly URL for the store.
plan_nameStringPlan name of the store.
opening_hours
[
    {
        "open": "Time",
        "close": "Time"
    }
]
payment_methods[String]Lists of payment methods accepted.
can_home_deleverBooleanwhether home delivers food.
adressline1String
addressline2String
landmarkString
stateString
cityString
districtString
countryString
latitudeNumber
longitudeNumber
emailString
phoneString
is_activeBooleanWhether the store is active or not
Response
Status: 201

Order Grocery

To order the groceries.

PUT
/stores/order

Parameters
access_token String A valid access token.
item_idIDID of the store grocery.
quantityNumberQuantity of the store grocery.
Response
Status: 201

Comment Store

Comment about the store.

PUT
/stores/:store_id

Parameters
access_token String A valid access token.
commentStringBody of the comment.
ratingNumberRating of the recipes in the order 1-5.
Response
Status: 201

Report Store

Report the Store.

PUT
/stores/:store_id

Parameters
access_token String A valid access token.
reason-typeStringType of the report reason.
reason-bodyStringBody of the report reason.
Response
Status: 201

Delete store

Delete the store.

DELETE
/stores/:store_id

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