Skip to content

Update README.md #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
emreutkan wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README.md #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91094fb
Refactor 2 (#47)
emreutkan Apr 19, 2025
dce329d
Update README.md
emreutkan Apr 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# FreshDealBackend
https://freshdealbackend.azurewebsites.net/

56 changes: 46 additions & 10 deletions src/routes/purchase_routes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@

purchase_bp = Blueprint("purchase", __name__)

##
@purchase_bp.route("/purchase", methods=["POST"])
@jwt_required()
@swag_from({
Expand All @@ -25,7 +24,9 @@
"If the cart is empty or any item exceeds available stock, the request will fail. "
"The resulting purchase orders will have a **PENDING** status until the restaurant accepts or rejects them. "
"If `is_delivery = false`, you can optionally include `pickup_notes`. "
"If `is_delivery = true`, you **must** provide `delivery_address`, and you can optionally include `delivery_notes`."
"If `is_delivery = true`, you **must** provide `address_id` or delivery address details.\n\n"
"Current Date and Time (UTC - YYYY-MM-DD HH:MM:SS formatted): 2025-04-19 15:42:48\n"
"Current User's Login: emreutkan"
),
"security": [{"BearerAuth": []}],
"requestBody": {
Expand All @@ -41,15 +42,35 @@
"description": "Flag to indicate if this is a delivery order",
"example": False
},
"address_id": {
"type": "integer",
"description": "ID of the saved address to use for delivery",
"example": 1
},
"pickup_notes": {
"type": "string",
"description": "Optional notes for pickup orders (ignored if is_delivery=true)",
"example": "Will pick up at 6pm"
},
"delivery_address": {
"type": "string",
"description": "Required only if is_delivery=true",
"example": "123 Main St, YourCity"
"description": "Required only if is_delivery=true and address_id not provided",
"example": "123 Main St"
},
"delivery_district": {
"type": "string",
"description": "District/area name for analytics",
"example": "Downtown"
},
"delivery_province": {
"type": "string",
"description": "Province/state name",
"example": "Istanbul"
},
"delivery_country": {
"type": "string",
"description": "Country name",
"example": "Turkey"
},
"delivery_notes": {
"type": "string",
Expand All @@ -66,11 +87,22 @@
"pickup_notes": "Will pick up at 6pm"
}
},
"delivery_order": {
"summary": "Example (Delivery)",
"delivery_order_with_saved_address": {
"summary": "Example (Delivery with saved address)",
"value": {
"is_delivery": True,
"delivery_address": "123 Main St, YourCity",
"address_id": 1,
"delivery_notes": "Please leave at the back door"
}
},
"delivery_order_with_new_address": {
"summary": "Example (Delivery with new address)",
"value": {
"is_delivery": True,
"delivery_address": "123 Main St",
"delivery_district": "Downtown",
"delivery_province": "Istanbul",
"delivery_country": "Turkey",
"delivery_notes": "Please leave at the back door"
}
}
Expand Down Expand Up @@ -104,9 +136,13 @@
"enum": ["PENDING", "ACCEPTED", "REJECTED", "COMPLETED"],
"example": "PENDING"
},
"is_delivery": {"type": "boolean", "example": False},
"delivery_address": {"type": "string", "example": None},
"delivery_notes": {"type": "string", "example": None}
"is_delivery": {"type": "boolean", "example": True},
"address_title": {"type": "string", "example": "Home"},
"delivery_address": {"type": "string", "example": "123 Main St"},
"delivery_district": {"type": "string", "example": "Downtown"},
"delivery_province": {"type": "string", "example": "Istanbul"},
"delivery_country": {"type": "string", "example": "Turkey"},
"delivery_notes": {"type": "string", "example": "Please leave at the back door"}
}
}
}
Expand Down