sign-in

dev-v1

https://test-api.bringthisfood.com/v1

POST

/auth/sign-in

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠400400 - bad request

🟠401401 - unauthorised

🟠403403 - forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://test-api.bringthisfood.com/v1/auth/sign-in' \
--header 'x-user-device: <deviceId> <deviceFCMToken>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "telephone": "+2349012345678",
    "password": "string"
}'

Response Example

200 - Example 1

{
    "data": {
        "store": {
            "id": "string",
            "slug": "string",
            "name": "string",
            "telephone": "+2349012345678",
            "category": "food",
            "picture": {
                "mimeType": "string",
                "url": "string"
            },
            "locations": [
                {
                    "city": "Ile - Ife (Off Campus)",
                    "street": "Parakin",
                    "description": "Beside AP filling station, KM 4, Ede Road",
                    "coordinates": {
                        "latitude": 0,
                        "longitude": 0
                    }
                }
            ],
            "review": {
                "totalRaters": 0,
                "rating": 0
            },
            "delivery": {
                "price": {
                    "min": {
                        "currency": "ngn",
                        "amount": 0
                    }
                },
                "time": {
                    "min": 0,
                    "max": 0
                }
            },
            "items": {
                "averagePrice": {
                    "currency": "ngn",
                    "amount": 0
                }
            },
            "active": true,
            "open": true,
            "orders": {
                "unassigned": {
                    "total": 0
                }
            },
            "web": {
                "link": "string"
            },
            "viewer": {
                "reacted": true,
                "reaction": "love",
                "permissions": [
                    "order-management"
                ],
                "hasBlocked": true
            },
            "menu": {
                "pack": {
                    "price": {
                        "currency": "ngn",
                        "amount": 0
                    }
                }
            },
            "availability": {
                "weekly": {
                    "sun": {
                        "start": "17:00:00",
                        "end": "17:00:00"
                    },
                    "mon": {
                        "start": "17:00:00",
                        "end": "17:00:00"
                    },
                    "tue": {
                        "start": "17:00:00",
                        "end": "17:00:00"
                    },
                    "wed": {
                        "start": "17:00:00",
                        "end": "17:00:00"
                    },
                    "thur": {
                        "start": "17:00:00",
                        "end": "17:00:00"
                    },
                    "fri": {
                        "start": "17:00:00",
                        "end": "17:00:00"
                    },
                    "sat": {
                        "start": "17:00:00",
                        "end": "17:00:00"
                    }
                }
            },
            "banks": [
                {
                    "code": "string",
                    "name": "string",
                    "account": {
                        "name": "string",
                        "number": "string"
                    },
                    "id": "string"
                }
            ],
            "wallet": {
                "balance": {
                    "currency": "ngn",
                    "amount": 0
                },
                "pin": {
                    "enabled": true
                }
            }
        },
        "user": {
            "id": "string",
            "active": true,
            "locations": [
                {
                    "city": "Ile - Ife (Off Campus)",
                    "street": "Parakin",
                    "description": "Beside AP filling station, KM 4, Ede Road",
                    "coordinates": {
                        "latitude": 0,
                        "longitude": 0
                    }
                }
            ],
            "name": "string",
            "role": {
                "main": "rider",
                "category": "platform",
                "status": "pending"
            },
            "telephone": "+2349012345678",
            "verified": true,
            "picture": {
                "mimeType": "string",
                "url": "string"
            },
            "review": {
                "totalRaters": 0,
                "rating": 0
            },
            "banks": [
                {
                    "code": "string",
                    "name": "string",
                    "account": {
                        "name": "string",
                        "number": "string"
                    },
                    "id": "string"
                }
            ],
            "wallet": {
                "balance": {
                    "currency": "ngn",
                    "amount": 0
                },
                "pin": {
                    "enabled": true
                }
            },
            "orders": {
                "statuses": {
                    "ongoing": {
                        "timestamp": {
                            "start": "2025-10-08T15:30:00.451Z",
                            "end": "2025-10-08T15:30:00.451Z"
                        }
                    },
                    "accepted": {
                        "timestamp": {
                            "start": "2025-10-08T15:30:00.451Z",
                            "end": "2025-10-08T15:30:00.451Z"
                        }
                    }
                },
                "box": {
                    "locked": true
                }
            },
            "email": "string",
            "emailVerified": true,
            "notifications": {
                "push": {
                    "enabled": true
                }
            }
        },
        "chats": {
            "totalUnread": 0
        },
        "tokens": {
            "access": "string",
            "refresh": "string"
        }
    }
}

Modified at 2025-11-26 16:12:22

sign-up

sign-out