def post(self, product_id, tag):
"""
adds a tag for a product
:param product_id: product to be updated
:param tag: new tag
:return: product object
"""
store = Store.objects.filter(app_id=request.headers.get('APP-ID'),
deleted_at=None).first()
product = Product.objects.filter(product_id=product_id,
deleted_at=None,
store=store).first()
if not product:
return jsonify({}), 404
try:
product.add_tag(new_tag=tag)
except DuplicateDataError:
response = {
"result": "already exists",
"product": product_obj(product)
}
return jsonify(response), 303
response = {"result": "ok", "product": product_obj(product)}
return jsonify(response), 201
def put(self, product_id):
"""
Endpoint /product/58829620864631543564022316902169146987/inventory
Add to or subtract from inventory amount by supplying amount in the post body
Example Post Body:
{
"amount": 5
}
Or
{
"amount": -5
}
Set inventory to a specific amount
{
"set": 5
}
"""
store = Store.objects.filter(app_id=request.headers.get('APP-ID'),
deleted_at=None).first()
product = Product.objects.filter(product_id=product_id,
deleted_at=None,
store=store).first()
if not product:
return jsonify({}), 404
if "amount" in request.json and "set" in request.json:
return jsonify(
{"error": "DONT_INCLUDE_SET_AND_AMOUNT_IN_SAME_REQUEST"}), 400
if "amount" in request.json:
try:
product.adjust_inventory(request.json.get("amount"))
except ProductInventoryLessThanZeroException:
return jsonify(
{"error": "PRODUCT_INVENTORY_MUST_BE_MORE_THAN_ZERO"}), 400
response = {"result": "ok", "product": product_obj(product)}
return jsonify(response), 201
if "set" in request.json:
try:
product.set_inventory(request.json.get("set"))
except ProductInventoryLessThanZeroException:
return jsonify(
{"error": "PRODUCT_INVENTORY_MUST_BE_MORE_THAN_ZERO"}), 400
response = {"result": "ok", "product": product_obj(product)}
return jsonify(response), 201
return jsonify({"error": "INCLUDE_SET_OR_AMOUNT_IN_REQUEST"}), 400
def invoice_line_item_obj(invoice_line_item):
return {
"invoice_line_item_id": invoice_line_item.invoice_line_item_id,
"product": product_obj(invoice_line_item.product),
"quantity": invoice_line_item.quantity,
"unit_amount_in_cents": invoice_line_item.unit_amount_in_cents,
"total_amount_in_cents": invoice_line_item.total_amount_in_cents,
"tax_amount_in_cents": invoice_line_item.tax_amount_in_cents,
"type": invoice_line_item.type,
"links": {
"invoice": "/invoice/" + invoice_line_item.invoice.invoice_id,
"product": "/product/" + invoice_line_item.product.product_id
}
}
def post(cls):
"""
Creates a new product.
Endpoint: /product/
Example Post Body:
{
"title": "PS4",
"product_type": "Electronics",
"vendor": "Sony"
}
Example response:
{
"product": {
"created_at": "Sat, 22 Dec 2018 22:45:50 GMT",
"id": "ef5a799c-7f43-412e-89a3-ed666f605482",
"product_type": "Electronics",
"title": "PS4",
"updated_at": "Sat, 22 Dec 2018 22:45:50 GMT",
"vendor": "Electronics"
},
"result": "ok"
}
"""
product_json = request.json
error = best_match(Draft4Validator(schema).iter_errors(product_json))
if error:
return jsonify({"error": error.message}), 400
store = Store.objects.filter(app_id=request.headers.get('APP-ID'),
deleted_at=None).first()
product = Product(
product_id=str(uuid.uuid4().int),
title=product_json.get("title"),
product_type=product_json.get("product_type"),
vendor=product_json.get("vendor"),
inventory=product_json.get("inventory"),
sale_price_in_cents=product_json.get("sale_price_in_cents"),
description=product_json.get("description"),
store=store).save()
response = {"result": "ok", "product": product_obj(product)}
return jsonify(response), 201
def put(cls, product_id):
"""
update a specific product
Endpoint: /product/88517737685737189039085760589870132011
Example Body:
{
"title": "Kitty Litter",
"product_type": "Pets",
"vendor": "Pet Co"
}
"""
store = Store.objects.filter(app_id=request.headers.get('APP-ID'),
deleted_at=None).first()
product = Product.objects.filter(product_id=product_id,
deleted_at=None,
store=store).first()
if not product:
return jsonify({}), 404
product_json = request.json
error = best_match(Draft4Validator(schema).iter_errors(product_json))
if error:
return jsonify({"error": error.message}), 400
product.title = product_json.get("title")
product.product_type = product_json.get("product_type")
product.vendor = product_json.get("vendor")
product.sale_price_in_cents = product_json.get("sale_price_in_cents")
if product_json.get("description") is not None:
product.description = product_json.get("description")
product.updated_at = datetime.now()
product.save()
response = {"result": "ok", "product": product_obj(product)}
return jsonify(response), 201
def delete(self, product_id):
"""
deletes all or one tag
:param product_id: product to be updated
:return: product obj
"""
store = Store.objects.filter(app_id=request.headers.get('APP-ID'),
deleted_at=None).first()
product = Product.objects.filter(product_id=product_id,
deleted_at=None,
store=store).first()
if not product:
return jsonify({}), 404
deleted_tags = product.delete_tags(
tag_to_delete=request.args.get("tag"))
if len(deleted_tags) == 0:
return jsonify({}), 404
response = {"result": "ok", "product": product_obj(product)}
return jsonify(response), 204
def get(self, product_id=None):
"""
Gets a product by providing product_id
Endpoint: /product/242025312983347096410127212123600214518
Example response:
{
"pet": {
"created_at": "Sun, 23 Dec 2018 00:34:16 GMT",
"product_id": "242025312983347096410127212123600214518",
"product_type": "Furniture",
"title": "Table",
"updated_at": "Sun, 23 Dec 2018 00:34:16 GMT",
"vendor": "Furniture"
},
"result": "ok"
Gets a all products. Use 'page' in query string to get specific page
Endpoint: /product/
Query String Parameters:
vendor (Filter by vendor)
producttype (Filter by product_type)
Example response:
{
"links": [
{
"href": "/product/?page=1",
"rel": "self"
},
{
"href": "/product/?page=2",
"rel": "next"
}
],
"products": [
{
"created_at": "Tue, 01 Jan 2019 00:51:04 GMT",
"deleted_at": null,
"product_id": "131077205055504776670923389866612113556",
"product_type": "Furniture",
"title": "Bed",
"updated_at": "Tue, 01 Jan 2019 00:51:04 GMT",
"vendor": "Bed Co"
},
{
"created_at": "Tue, 01 Jan 2019 00:52:11 GMT",
"deleted_at": null,
"product_id": "121476741205384160963298713726176220007",
"product_type": "Furniture",
"title": "Couch",
"updated_at": "Tue, 01 Jan 2019 00:52:11 GMT",
"vendor": "Bed Co"
},
{
"created_at": "Tue, 01 Jan 2019 00:52:39 GMT",
"deleted_at": null,
"product_id": "323273601821423060193594938496970868250",
"product_type": "Furniture",
"title": "Table",
"updated_at": "Tue, 01 Jan 2019 00:52:39 GMT",
"vendor": "Funiture Sto"
},
],
"result": "ok"
}
"""
store = Store.objects.filter(app_id=request.headers.get('APP-ID'),
deleted_at=None).first()
if product_id:
product = Product.objects.filter(product_id=product_id,
deleted_at=None,
store=store).first()
if product:
response = {"result": "ok", "product": product_obj(product)}
return jsonify(response), 200
else:
return jsonify({}), 404
else:
href = "/product/?page=%s"
products = Product.objects.filter(store=store, deleted_at=None)
if "vendor" in request.args:
products = products.filter(vendor=request.args.get('vendor'))
href += "&vendor=" + request.args.get('vendor')
if "producttype" in request.args:
products = products.filter(
product_type=request.args.get('producttype'))
href += "&producttype=" + request.args.get('producttype')
page = int(request.args.get('page', 1))
products = products.paginate(page=page, per_page=self.PER_PAGE)
response = {
"result": "ok",
"links": [{
"href": href % page,
"rel": "self"
}],
"products": products_obj(products)
}
if products.has_prev:
response["links"].append({
"href": href % products.prev_num,
"rel": "previous"
})
if products.has_next:
response["links"].append({
"href": href % products.next_num,
"rel": "next"
})
return jsonify(response), 200
def order_line_item_obj(order_line_item):
return {
"order_line_item_id": order_line_item.order_line_item_id,
"product": product_obj(order_line_item.product),
"quantity": order_line_item.quantity
}