API Guide

Live API Link + Swagger UI

https://shielded-lake-43806.herokuapp.com/

Customer

Method	Action	Endpoint	Arguments	Body	Complete
GET	Get all customers	/customer/	-	-
GET	Get customer by id	/customer/id	-	-
POST	Add customer	/customer/	-	name, point_of_contact, email, street, city, province, country, postal code, phone
PUT	Update customer	/customer/id	-	name, point_of_contact, email, street, city, province, country, postal code, phone

Part

Method	Action	Endpoint	Arguments	Body	Complete
GET	Get all parts	/part/	-	-
GET	Get part by id	/part/id	-	-
GET	Get all parts by customer_id	/part?	customer_id	-
POST	Add part	/part/	-	number, name, purchase_order_id, customer_id
PUT	Update part	/part/id	-	name

Purchase Order

Method	Action	Endpoint	Arguments	Body	Complete
GET	Get all purchase orders and associated parts	/purchase_order/	-	-
GET	Get purchase order by id	/purchase_order/id	-	-
GET	Get all orders by customer_id	/purchase_order?	customer_id	-
POST	Add order	/purchase_order/	-	customer_id, number

Receiving Order

Method	Action	Endpoint	Arguments	Body	Complete
GET	Get all receiving orders	/receiving_order/	-	-
GET	Get receiving order by id	/receiving_order/id	-	-
GET	Get all receiving orders by customer_id	/receiving_order?	customer_id	-
POST	Add receiving order	/receiving_order/	-	customer_id, customer_packing_slip, date* [format: "month/day/year hour:minute:second"]
PUT	Update receiving order	/receiving_order/id	-	customer_packing_slip

Received Part

Method	Action	Endpoint	Arguments	Body	Complete
POST	Add received part	/received_part/	-	part_id, receiving_order_id, part_quantity_bins