/Public-OSA-WareHouse-API

The OSA-WareHouse-API purpose is to aid Developers to develop their ecommerce Websites by using the High Quality Real Products from Popular e-commerce Websites that our API supply. Not For Commercial Purposes

MIT LicenseMIT

forthebadge made-with-python javascript PostreSQL HTML CSS Pandas Json Bootstrap Flask Git Heroku Analytics Pycharm GitHub Markdown

Hi , I am Omar Sherif Ali

Computer Science Engineer | FullStack Web & API Developer


Welcome to OSA-WareHouse-API

Logo

E-commerce API

An E-commerce API to aid Developers for their E-commerce practice projects!
Explore the docs »

View The WareHouse API · Get Your api_key · Report Bug · Be a Contributer


The Repository of WareHouse API is Private

💡 Description

As someone who is willing to practice creating e-commerce websites, It is a struggle to find some Real and High Quality Data as a placeholder while on development stage. So this API's job is to help Developer's to reach out to this data that can help them and make it easier .

⚠️ Disclaimer

Users who will Use this Data should only use it for Practice and not for Commercial Purposes !

WareHouse API Features

  • Reach Out To Product data with wide varieties of categories and sub-categories from Popular up-to-date Ecommerce Sources
  • Data Format Data is formatted in JSON Format according to standards.
  • Product UploadThe API Accepts only quality data that succeeds only with the API Data Validators to insure Real and High Quality Data
  • Product Storage and Download into Excel file User and Companies can store their Product Data into their Inventory and later on they can download it easily in a well formatted Excel File including all of their Products and their details
  • Profile Storage and Download into Excel file User and Companies can store their Profile Information Data and later on they can download it easily in a well formatted Excel File including all of their Products and their details
  • Search Products by Filters The WareHouse API contains many filter options when searching for Products
  • Upload Inventory by Excel File The WareHouse API is able to read Excel File but under certain conditions to upload all the User's Product faster and easier
  • User control their Product User can control their product's in terms of Safety , changing Product's info or deleting a Product

User Features


  • name : represents the User's name Required
  • email : represents the User's email Required
  • phone : represents the User's phone Required
  • country : represents the User's country Required
  • api_key : represents the User's Api Key which is the key that give's access to the User to use the WareHouse API Required
  • status : represents the User's status either Company or User Required
    • Company
      • service : represents the Company's service Required
      • company_url : represents the Company's url Required
    • User
      • birth_date : represents the User's birth date Required
      • gender : represents the User's gender Required
  • since : represents when did the user signed up for the WareHouse API auto Not-Required

(back to top)

Product Features


  • product_name : represents the Product's name Required
  • category : represents Category of the product Required
  • sub_category : represents Sub-category of the product Not-Requiredas not every Company has that feature
  • brand : represents the Product's Brand Required
  • price : represents the Product's Price Required
  • img_url : represents the Product's img_url Required
  • category : represents the if the Product is in the WareHouse or out of StockRequired
  • delivery : represents the if Product have Delivery option Required
  • product_description : represents the Product's description Required
  • currency : represents the Product's price currency Required
  • product_url : represents the Product's original page url Required
  • source_name : represents the Product's price currency Required
  • rating : represents the Product's rating Required
  • release_date : represents when did the Product is Uploaded to the API Required
  • product_id : represents the Product's id which is hashed unique for every product for the owner can share to user who doesnt own it so he can view and edit it. Required
  • secure : hashes the product_id for a product and it will be sent via email with it qr-code for the owner can share to user who doesn't own it so he can view and edit it. Not-Required default = false

(back to top)

JSON Data Format Example :

    "response": {
        "data": {
            "number_of_products": 1,
            "products": [
                {
                    "product_1": {
                        "owner": {
                            "country": "Egypt",
                            "email": "demo@gmail.com",
                            "gender": "Male",
                            "name": "Nour",
                            "number_of_products": 1,
                            "phone": "+021008757777",
                            "since": "October 7,2021",
                            "status": "User"
                        },
                        "product": {
                            "available": true,
                            "brand": "Polo",
                            "category": "Clothes",
                            "currency": "EGP",
                            "delivery": true,
                            "img_url": "https://m.media-amazon.com/images/I/610zGpHMF0L._AC_SY550_.jpg",
                            "price": 46,
                            "product_description": "100% Cotton",
                            "product_name": "Us. Polo Assn. Cotton Contrast-Logo Ribbed Trims Round-Neck Sweatshirt For Boys",
                            "product_url": "https://www.amazon.eg/-/en/US-Polo-Assn-Contrast-Logo-Round-Neck/dp/B08WJNLZF6/ref=lp_18018165031_1_11?th=1",
                            "rating": "4.2 out of 5",
                            "release_date": "October 7,2021",
                            "source_name": "Amazon"
                        }
                    }
                }
            ]
        },
        "success_message": "Products Found"
    },
    "status": "success"
}

(back to top)

💻️ Languages & Concepts Used

(back to top)

Postman

Used Postman to help me to test my program and write the Documentation


FrameWork

Libraries Used

  • Selenium : for website flow testing
  • BeatufilSoup : for Scraping the Product's data
  • qrcode : for creating a unique Qrcode for User's Inventory
  • Pandas & Csv : for creating and manipulating Excel files uploaded and downloaded by the user.
  • urlshortners: for creating short urls

Author: Omar Sherif Ali - OSA

(back to top)

Connect with me


Made with ❤️ by Omar Sherif Ali - OSA.

© OSA - 2021

(back to top)