Stores Endpoint

TIP

Refer to note page for Base URL

* List Stores

Endpoint: GET

stores

Parameters
Not required

Sample Response

{
  "count": 7,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "5aaa5320-92d5-4ed8-b0b0-e76f44ad4266",
      "name": "Official Store",
      "about": "Shoes and Clothing",
      "state": "Greater Accra Region",
      "street": "spintex road, accra, ghana",
      "slug": "official-store-673"
    },
  ]
}

* Store Details

Endpoint: GET

stores/store_slug

Parameters

Name	Type	Description	Required
store_slug	string	eg. sneakers-hub	✔️

Sample Request

stores/sneakers-hub

Sample Response

{
  "slug": "sneakers-hub",
  "about": "we sell clothing",
  "name": "Sneakers Hub",
  "categories": [
      "Men",
      "Girls"
  ],
  "state": "Ahafo Region",
  "followers": "1"
}

* User Followed Stores

Endpoint: GET

store/user/

Request Headers

Authorization	Value	Description	Required
Bearer	***	Firebase access token	✔️

Parameters

Not required

Sample Response

[
  {
    "id": "b130219a-b898-4a31-8500-6c8c64b3c485",
    "store": {
      "name": "Sam-Kay Fashion Store",
      "id": "0e91a1fb-a8e9-4bea-80db-7f745cfb112c",
      "image": "shops/2023 - 02/download.png",
      "about": "Clothing and Shoes.",
      "state": "Greater Accra Region",
      "street": "East Legon",
      "slug": "sam-kay-fashion-store-9207"
    }
  }
]

* Follow Store

Endpoint: POST

stores/follow/

Request Headers

Authorization	Value	Description	Required
Bearer	***	Firebase access token	✔️

Payload Description

Name	Type	Description	Required
storeSlug	string	store slug	✔️

Sample Payload

{
  "storeSlug": "the-hypers-clothing-storter6d-7604"
}

Sample Response

{
  "id": "6af3cff3-72e0-4172-971b-0b1b396cf5af",
  "follower": "BhEBaVwyGNdaCaAMLmRqIgJpByU2s",
  "storeID": "c5897690-c5be-44f2-9003-dd078ea67ff5"
}

* Unfollow Store

Endpoint: DELETE

stores/unfollow/store_slug

Request Headers

Authorization	Value	Description	Required
Bearer	***	Firebase access token	✔️

Parameters

Name	Type	Description	Required
store_slug	string	store slug	✔️

Sample Request

stores/unfollow/the-hypers-clothing-storter6d-7604

Sample Response

{
  "status": "204 No Content",
}

* Followed Store Instance

Helps to verify if a user is following a store or not.

Endpoint: GET

stores/follow/instance/store_slug

Request Headers

Authorization	Value	Description	Required
Bearer	***	Firebase access token	✔️

Parameters

Name	Type	Description	Required
store_slug	string	store slug	✔️

Sample Request

stores/follow/instance/the-hypers-clothing-storter6d-7604

Sample Response

[
  {
    "id": "b130219a-b898-4a31-8500-6c8c64b3c485",
    "userId": "BhEBaVwyGNdaCaAMLmRqIgJpByU2",
    "storeId": "0e91a1fb-a8e9-4bea-80db-7f745cfb112c"
  }
]

* Full Text Search

Searches against store name, & about

Endpoint: POST

stores/search/?search=param

Query Parameters

Name	Type	Description	Required
param	string	eg. official store	✔️

Sample Request

stores/search/?search=official store

Sample Response

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "269e7656-f23b-46ad-83d7-46b5f5504dd6",
      "name": "Official Store",
      "about": "we sell clothing",
      "state": "Ashanti Region",
      "street": "Agogo",
      "slug": "official-store"
    },
  ]
}