Bring This Food
  1. https
Bring This Food
  • https
    • _readme
    • v1
      • alerts
        • get alerts - customer | rider
        • get alerts - store
        • mark alerts read - customer | rider
        • mark alerts read - store
      • auth
        • reset password
        • sign-up
        • sign-in
        • sign-out
        • refresh tokens
      • chat
        • send message to user
        • send message to store
        • send message to chat
        • get messages
        • update messages
        • get chat
      • chats
        • get chats
      • existence
        • telephone existence
      • finance
        • get nigerian banks
        • resolve account number
        • initiate one-time payment
      • invite-code
        • request for invite code
      • order
        • get order
        • cancel order - customer
        • update delivery - customer
        • reject or cancel order - store | rider
        • accept order - store | rider
        • update status - store | rider
        • notify riders - store
        • unnotify riders - store
      • orders
        • get all orders - customer
        • get all orders - rider
        • get all orders - store
        • get orders by status - customer
        • get orders by status - rider
        • get orders by status - store
        • get orders metadata - store
      • order-complaint
        • complain on an order
        • delete order complaint
      • order-complaints
        • get complaints - store
      • otp
        • send otp
        • verify otp
      • pagination
        • first request
        • next request
      • request
        • revoke request - store
        • update request - store
        • accept request - store
        • reject request - store
      • requests
        • get all requests - store
        • get assistant requests - store
        • get rider requests - store
      • resources
        • get faqs
        • get faqs by types
        • get ile-ife streets
      • slug
        • get store by slug
        • get order by slug
      • store
        • get store
        • delete store
        • update store
        • block a store
        • unblock a store
        • love a store
        • unlove a store
        • send request - assistant | rider
        • post review
        • update review
        • delete review
        • get reviews - all
        • get reviews - by rating
        • get reviews metadata
      • store-analytics
        • get store analytics
      • store-cart
        • get store cart
        • update store cart
        • cart checkout
        • clear cart
      • store-menu
        • add category
        • update category
        • delete category
        • get categories
        • add item - combo
        • add item - other(categorised item)
        • update item
        • delete item
        • get items - all
        • get items - combo
        • get items - other (non-combo)
        • get items - categorised
      • stores
        • get stores
        • get featured stores
        • get food recommendations
      • support
        • get open ticket
        • create ticket
        • send message
        • get messages
      • time
        • timezone offset
      • transaction
        • get transaction
      • transactions
        • get store transactions
        • get customer transactions
        • get assistant transactions
        • get rider transactions
      • upload
        • read-me for signed upload url
        • get signed upload url(s)
        • upload file
      • user
        • get user
        • update user
        • update password
        • confirm role category - independent
        • confirm role category - platform
        • confirm role category - vendor
        • post review
        • update review
        • delete review
        • get reviews metadata
        • get reviews - all
        • get reviews - by rating
        • get customer carts
      • user-account
        • get - account
        • delete - account
        • create store
      • wallet
        • get wallet - store
        • get wallet - customer | rider
        • update pin - store
        • update pin - customer | rider
        • get withdrawal fee - store
        • get withdrawal fee - rider
        • withdraw funds - store
        • withdraw funds - rider
  • wss
    • _readme
    • auth
      • handshake
    • alert
      • alert.new
      • alert.update
    • chat
      • chat.get
      • chat.message.new
      • chat.message.post
      • chat.messages.get
      • chat.messages.update
      • chats.get
    • order
      • order.new
      • order.update
      • order.complaint.new
      • rider.order.assignment.time.ended
      • rider.orders.addition.time.ended
    • ping
      • ping server
    • request
      • request.new
      • request.update
    • support
      • support.ticket.open.get
      • support.ticket.message.new
      • support.ticket.message.post
      • support.ticket.messages.get
    • transaction
      • transaction.new
      • transaction.update
  • Schemas
    • v1
      • alert
        • alertType
        • alertSubject
        • basicAlert
        • alert
      • chat
        • basicChatMessage
        • chatMessage
        • reqCreateChatMessageBody
        • basicChat
        • chat
        • messageDeliveryStatus
        • updateMessagesMap
        • basicMessagesMap
        • basicMessageSender
      • entity
        • entityType
        • basicEntity
        • typedEntity
      • faq
        • faqTextBlockProps
        • faq
        • faqTextBlockInnerProps
      • file
        • uploadedFile
      • finance
        • userBank
        • userBankWithId
        • paymentMethod
        • paymentBeneficiary
      • get-request
        • paginationProps
      • order
        • basicUserOrder
        • extendedUserOrder
        • userOrder
        • customerOrderStatus
        • riderOrderStatus
        • storeOrderStatus
        • orderTimeline
        • orderTracking
        • ordersMetadata
        • ordersMetadataStatusProps
        • orderRider
        • extendedOrderCustomer
        • orderCustomer
        • orderPaymentStatus
        • orderPayment
        • orderStore
      • order-complaint
        • basicOrderComplaint
        • orderComplaint
      • otp
        • otp
      • platform
        • platformClientType
      • price
        • priceProps
      • responses
        • 200 - success
        • 208 - already done
        • 400 - bad request
        • 401 - unauthorised
        • 403 - forbidden
        • 404 - not found
        • 409 - conflict
        • 410 - gone
        • 500 - server error
      • review
        • reviewRating
        • reviewRatingProps
        • reviewsSummary
        • reviewsMetadata
      • status
        • executionStatus
      • store
        • basicUserStore
        • extendedUserStore
        • userStore
        • basicStoreViewer
        • extendedStoreViewer
        • userStoreMenu
        • userStoreRequest
        • userStorePermission
        • basicUserStoreReview
        • storeCartItem
        • storeCartItemGroup
        • userBasicStoreCart
        • userExtendedStoreCart
        • userStoreCart
        • storeCartSummaryItemProps
        • cartSummary
        • storeAnalytics
        • userStoreCategory
      • store-menu
        • storeMenuCategory
        • storeMenuComboItem
        • storeMenuCategorisedItem
      • support
        • basicSupportMessage
        • supportTicketStatus
        • supportMessage
        • supportTicket
        • reqCreateSupportTicketMessageBody
      • time
        • iso24HrTime
        • weeklyAvailability
        • timeRangeProps
        • timezoneOffset
        • isoDateTime
        • dateTimeRangeProps
      • transaction
        • basicTransaction
        • extendedTransaction
        • transaction
        • customerTransactionCategory
        • riderTransactionCategory
        • storeTransactionCategory
        • assistantTransactionCategory
        • transactionSummary
        • transactionPayment
        • paymentStatus
      • user
        • basicUser
        • extendedUser
        • user
        • location
        • userTelephone
        • userTokens
        • userRole
        • userPassword
        • verificationStatus
        • basicUserReview
        • deliveryProps
        • userAccount
        • currentRiderOrdersMapItemProps
      • wallet
        • userWallet
      • websocket
        • wsResponseType
        • wsRequestAction
  1. https

_readme

Client Type#

When request is to be made to the server; it is required to add the type of the client making the request to the request headers; this helps determine the accurate data for the client;
"x-platform-client-type": platformClientType
platformClientType

Push Notifications#

To auto-enable push notifications for a user by default; the header x-user-device is to be supplied in the following endpoints:
sign-up
sign-in
the request headers look this way;
To manually enable/disable push notifications, the update user should be used with the header;
Modified at 2026-01-24 16:42:59
Next
get alerts - customer | rider
Built with