PropertyFinderSaleAPI

Requirement for API

Summary

In this project, expectation is develop a basket service. The service will be a REST API developed in Go.

Customers will be able to purchase existing products. Use cases such as creating, updating, deleting products or creating users etc. for admin won’t be developed. You can just insert necessary data into the database using SQL for customer use cases to run. No UI will be developed. You can make your tests using REST test tools such as Postman.

The functions of this service

1. List Products

• Users should be able to list all products.

2. Add To Cart

• Users can add their products to the basket and the total of the basket changes accordingly.

3. Show Cart

• Users can list the products they have added to their cart and total price and VAT of the cart.

4. Delete Cart Item

• Users can remove the products added from the cart. Notice removing an item may change discount.

5. Complete Order

• Users can create an order with the products they add to their cart. There is no need to implement any payment mechanism. You can assume that when an order is completed it is fully paid.

Some business rules

1. Products always have price and VAT (Value Added Tax, or KDV).

VAT might be different for different products. Typical VAT percentage is %1, %8 and %18. So use these values for your products.

2. There might be discount in following situations:

• a. Every fourth order whose total is more than given amount may have discount depending on products. Products whose VAT is %1 don’t have any discount but products whose VAT is %8 and %18 have discount of %10 and %15 respectively.
• b. If there are more than 3 items of the same product, then fourth and subsequent ones would have %8 off.
• c. If the customer made purchase which is more than given amount in a month then all subsequent purchases should have %10 off.
• d. Only one discount can be applied at a time. Only the highest discount should be applied.

Expectations

1. Organize your code around packages.
2. Observe cohesion and coupling.
3. Apply clean code and clean architecture principles.
4. Apply Go idioms.
5. Create your own errors if needed.
6. “Given amount” in requirements can change so make it changeable.
7. Write unit tests for business logic only.
8. Apply well-known REST API patterns.
9. Use a well-known relational database such as MySQL or PostgreSQL.

How to Install

Firstly Clone the repository

git clone github.com/mervanerdem/PropertyFinderSaleAPI

After cloning if you don't have used library, install them.(It's not about using library but you can see in that link)

Build or Run it

For building

go build ./

Or Runing

go run ./

How to Use

In this project use the localhost.

baseURL: localhost:8080

List Products

In this case We will list product from MySQL database. use GET method with URL and URL is:

/api/products

The response is be like

{
  "Product List": "Successful",
  "Products": [
    {
      "ProductID": 1,
      "ProductName": "Bread",
      "ProductPrice": 4,
      "ProductVAT": 1
    },
    {
      "ProductID": 2,
      "ProductName": "Chicken",
      "ProductPrice": 45,
      "ProductVAT": 1
    },
    {
      "ProductID": 3,
      "ProductName": "cheese",
      "ProductPrice": 18,
      "ProductVAT": 1
    },
    {
      "ProductID": 4,
      "ProductName": "olives",
      "ProductPrice": 30,
      "ProductVAT": 1
    }
  ]
}

Add To Cart

In this case Products will be added to basket and save the data. use POST method with URL and URL is:

/api/:idCustomer/basket/add

And the customer id has to be assigned.

The body type has to be like:

{
    "ProductID": 4,
    "ProductNumber" : 3
}

The response is be like

{
  "Basket": [
    {
      "BasketID": 113,
      "CustomerID": 1,
      "ProductID": 4,
      "ProductName": "olives",
      "ProductPrice": 30,
      "ProductVAT": 1,
      "ProductNum": 3,
      "ProductTotalPrice": 81
    }
  ],
  "Message": "Successful",
  "Total Pay": 81
}

Show Cart

In this case We will list basket products. Data will be reading from database

use GET method with URL and URL is:

/api/:idCustomer/basket

And the customer id has to be assigned.

The response is be like

{
  "Basket": [
    {
      "BasketID": 113,
      "CustomerID": 1,
      "ProductID": 4,
      "ProductName": "olives",
      "ProductPrice": 30,
      "ProductVAT": 1,
      "ProductNum": 3,
      "ProductTotalPrice": 81
    }
  ],
  "Message": "Successful",
  "Total Pay": 81
}

Delete Cart Item

In this case Products will be deleted to basket and save the data. use POST method with URL and URL is:

/api/:idCustomer/basket/delete

And the customer id has to be assigned.

The body type has to be like:

{
    "ProductID": 4,
    "ProductNumber" : 1
}

The response is be like

{
  "Basket": [
    {
      "BasketID": 112,
      "CustomerID": 1,
      "ProductID": 4,
      "ProductName": "olives",
      "ProductPrice": 30,
      "ProductVAT": 1,
      "ProductNum": 2,
      "ProductTotalPrice": 54
    }
  ],
  "Message": "Successful",
  "Total Pay": 54
}

Complete Order

In this case, the products added to the cart by the customer will be sold and the data will be saved.

Use POST method with URL and URL is:

/api/:idCustomer/Sale

And the customer id has to be assigned.

No need body.

The response is be like

{
  "Message": "Successful",
  "Sale": [
    {
      "CustomerID": 1,
      "ProductID": 4,
      "ProductName": "olives",
      "ProductPrice": 30,
      "ProductVAT": 1,
      "ProductNum": 5,
      "ProductTotalPrice": 135,
      "SaleDate": "2022-08-08 22:02:21",
      "CampaignOrderNum": 2
    }
  ],
  "Total Pay": 135
}

Contributors for process

Thanks to Patika.dev for all courses and bootcamp.

Thanks to the bootcamp sponsor Property Finder for all the attention and instructions.