Design API for Logistics Microservice

lucasjellema / soaring-through-the-cloud-native-sequel

To support the Oracle Cloud demo "Soaring through the Clouds The Sequel" on microservices and container and cloud native computing. Our first performance: Oracle EMEA PaaS Partner Forum - March 2018, Budapest

4 stars 2 forks source link

Design API for Logistics Microservice #7

Open lucasjellema opened 6 years ago

lucasjellema commented 6 years ago

Define the (first draft) API for the Logistics (Shipping, Stock) microservice - ideally define this on Apiary

lucasjellema commented 6 years ago

This API supports:

Check Shipping Status (for a shipment)
Create Shipping (to a destination, using a certain delivery method, containing specific items, associated with an order?) - note: a shipping can only be created if all products in the order are allowable to be shipped to the indicated destination and if all products are currently in stock
Update Shipping (for a shipping, update status & associated details) - shipment prepared (order picked), shipment handed over to package service, shipment delivered to customer, shipment lost (?)
Check Stocklevel (for a product)
Set Stocklevel (for a product)

lucasjellema commented 6 years ago

Notes for POST /shipment (submit a shipment)

request includes:

destination (addressee, address (streetname, housenumber), postal code, city, country)
shipping method (options: fastest | most economical | ...)
order identifier
desired delivery date (for example: deliver on birthday next month, after when I return from holiday, when I am in that hotel)
giftwrapping
personal note
contents (list of product identifier, item count)

response contains:

shipping identifier
expected number of shipments?
expected date of first delivery?