The Order System is a microservice that handles ordering merchandise from an e-commerce web app. It stores the order history of a user, integrates with third-party payment providers such as PayPal and Stripe, and stores custom account information.
\nThis microservice is designed to be integrated with other services that handle things such as the product catalog to create a whole e-commerce platform.
\napplication/x-www-form-urlencoded type, they also support application/json.Creates a new order that a customer can pay for. The new order contains information such as the items in the order, the customer's billing address, and their shipping address.
\nAlthough this route does not require authentication, a token can be passed in and the email and id values in the payload will be used to identify the order. Otherwise, it will be considered a guest order.
Gets the order for a user with a specific ID. The order's user ID is fetched from the JWT auth token passed in the Authorization header.
Gets a user's order history. The orders are fetched that have a user ID matching the ID in the JWT auth token.
\n","urlObject":{"protocol":"http","port":"8080","path":["v1","orders"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"89a1808b-fa29-4f0c-ab21-c1a8964be0f6","name":"Get Orders for User","originalRequest":{"method":"GET","header":[],"url":"http://localhost:8080/v1/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"452"},{"key":"date","value":"Thu, 25 Oct 2018 21:17:40 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"status\": 0,\n \"userID\": 4533041739374140682,\n \"guest\": false,\n \"id\": 7,\n \"tax\": 1038,\n \"items\": [\n {\n \"quantity\": 4,\n \"sku\": \"672A75A7-EA1E-4D9A-95BC-11885E5070EE\",\n \"price\": 3500,\n \"tax\": 1038,\n \"taxRate\": 7.42,\n \"totalWithTax\": 15038,\n \"total\": 14000,\n \"description\": \"We have no description\",\n \"name\": \"Mince-meat Pie\"\n }\n ],\n \"refundedTotal\": 0,\n \"paymentStatus\": 0,\n \"total\": 14000,\n \"billingAddress\": {\n \"country\": \"Notherling\",\n \"street\": \"156 Plumberry Ln.\",\n \"zip\": \"15620\",\n \"city\": \"Cidersville\"\n },\n \"paidTotal\": 0\n }\n]"}],"_postman_id":"d49f6371-4416-4cc9-969b-ed8fc5192a18"},{"name":"Add Item to Order","event":[{"listen":"test","script":{"id":"8fd2dde7-a645-4b0e-9534-8fdc960c1313","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Added item object\", function () {"," var json = pm.response.json();"," var items = json.items.filter(function (el) { el.productID == 2 });"," "," pm.expect(items.length).to.equal(1);"," pm.expect(items[0].quantity).to.equal(2)","});"],"type":"text/javascript"}}],"id":"93c269c0-b2ae-4fea-9091-026dc18a9837","request":{"auth":{"type":"bearer","bearer":{"token":"{{jwt_token}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"productID\": 2,\n\t\"quantity\": 2\n}"},"url":"http://localhost:8080/v1/orders/{{order}}/items","description":"Adds a new item to an order model.
\n","urlObject":{"protocol":"http","port":"8080","path":["v1","orders","{{order}}","items"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"a3e88d6a-633c-4e87-ac76-e4890dce8ac3","name":"Add Item to Order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"productID\": 2,\n\t\"quantity\": 2,\n\t\"taxRate\": 7.42\n}"},"url":"http://localhost:8080/v1/orders/{{order}}/items"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"904"},{"key":"date","value":"Mon, 05 Nov 2018 22:39:57 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 0,\n \"userID\": 8994818343213048547,\n \"authToken\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImNyaXQiOlsiZXhwIiwiYXVkIl19.eyJleHAiOjY0MDkyMjExMjAwLCJlbWFpbCI6Imp3dC50b2tlbkBleGFtcGxlLmNvbSIsImlkIjo4OTk0ODE4MzQzMjEzMDQ4NTQ3LCJpYXQiOjE1NDE0NTcwNTMuMTY3MTJ9.JZRNNlSsE7pSTOHdWRJAGiKkEeBOzO_fyAvMge8Stz6QUIHlbUBPE9dkWutNGwxa_m61vnUVcnWQCwihU2VXT87AeKrkQP6mgzAqYyP2D5nB4VlwKnvKt0wvDeP4wT3FXOoQbjSWDYzPuYst95qEq81kbm_arx88bNLrIHlFpHXkgA5nr80xGKnqS-g71QdXTbnXQ3uO4PH4DJUiaPm1deeb1D3vMo9-bDu8P-n9zWJnD4cGS_HEXejajaahU8u-JP2LXbSosOcUI39T1a9PS7S44Awx9Qlh3dElaXnOsxP-vh9CmgafA2H9MM_o27LQJUn9I78dX1uJPFpAfZlHxw\",\n \"id\": 16,\n \"guest\": false,\n \"items\": [\n {\n \"taxRate\": 7.42,\n \"quantity\": 4,\n \"productID\": 1\n },\n {\n \"taxRate\": 7.42,\n \"quantity\": 2,\n \"productID\": 2\n }\n ],\n \"refundedTotal\": 0,\n \"email\": \"jwt.token@example.com\",\n \"paymentStatus\": 0,\n \"billingAddress\": {\n \"country\": \"Notherling\",\n \"street\": \"156 Plumberry Ln.\",\n \"zip\": \"15620\",\n \"city\": \"Cidersville\"\n },\n \"paidTotal\": 0\n}"}],"_postman_id":"93c269c0-b2ae-4fea-9091-026dc18a9837"},{"name":"Remove Item from Order","event":[{"listen":"test","script":{"id":"6e5d472f-7b2e-48e2-b460-fb11b72fec82","exec":["pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"af1cd1d7-0de8-4c58-b841-82a68c46e9dc","request":{"auth":{"type":"bearer","bearer":{"token":"{{jwt_token}}"},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:8080/v1/orders/{{order}}/items/{{item}}","description":"Removes an item from an order model.
\n","urlObject":{"protocol":"http","port":"8080","path":["v1","orders","{{order}}","items","{{item}}"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"b8571c3a-e43f-4ae3-9f45-157e1b4f9aff","name":"Remove Item from Order","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json","disabled":true}],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:8080/v1/orders/{{order}}/items/{{item}}"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"date","value":"Mon, 05 Nov 2018 22:45:11 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"af1cd1d7-0de8-4c58-b841-82a68c46e9dc"}],"id":"4fd811fa-0306-487d-ade9-87c144db291e","description":"An Order model represents the items a customer is purchasing from a merchant and handles additional metadata, such as the customer’s information (firstname, lastname, email, etc), its payment status, or if the order is made by a guest.
An order also as the parent for multiple other model types, including Item which represents a product in the order, Address which holds the information for the order’s payment or billing addresses, and Payment, which is the internal payment information that connects to an external payment from a third-party payment provider such as PayPal or Stripe.
The currency to use for the payment. (Required)
\n","type":"text"},{"key":"shipping","value":"3000","description":"The price of shipping.
\n","type":"text"},{"key":"shippingDiscount","value":"1200","description":"The discount the customer receives on the shipping price.
\n","type":"text"},{"key":"handling","value":"1500","description":"The price for handing.
\n","type":"text"},{"key":"insurence","value":"2000","description":"The price for insurence.
\n","type":"text"},{"key":"giftWrap","value":"250","description":"The price for gift wrap.
\n","type":"text"}]},"url":"http://localhost:8080/v1/orders/{{order}}/payment/paypal/create","description":"Creates a new PayPal payment based on an Order model's Item prices.
The response returned is the JSON representation of a PayPal link. Usually, you will redirect your client to the URI in the href key. The client can then authorize the PayPal payment so you can execute it.
The ID of the user in the PayPal system that is making the payment.
\n"},{"key":"paymentID","value":"PAY-0B756831FK924644ALPMFOXA","type":"text","description":"The ID of the payment to execute.
\n"}]},"url":"http://localhost:8080/v1/orders/{{order}}/payment/paypal/execute","description":"Executes a PayPal payment that was created for an order.
\nThe body of this request expects 2 values, payerID and paymentID. These values come from the accept redirect request for the payment that is executed.
payerID query-string key is PayerID and paymentID is paymentId.Takes a Stripe credit card token and creates a charge with it.
\n","urlObject":{"protocol":"http","port":"8082","path":["v1","orders","{{order}}","payment","stripe-cc"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"e5eabebf-efd7-4e2c-bd87-459e7c507d84","name":"Execute Stripe Payment for Order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"stripeToken","value":"tok_1DPGsL2DSdLg2fx4QreVIQGU","description":"The Strip credit card token, returned from the Stripe API when the data is submitted from your front-end. (Required)","type":"text"},{"key":"currency","value":"usd","description":"The currency to use for the payment. (Required)","type":"text"},{"key":"shipping","value":"3000","description":"The price of shipping.","type":"text"},{"key":"shippingDiscount","value":"","description":"The discount the customer receives on the shipping price.","type":"text","disabled":true},{"key":"handling","value":"1500","description":"The price for handing.","type":"text"},{"key":"insurence","value":"2000","description":"The price for insurence.","type":"text"},{"key":"giftWrap","value":"","description":"The price for gift wrap.","type":"text","disabled":true}]},"url":"http://localhost:8080/v1/orders/{{order}}/payment/stripe-cc"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"36"},{"key":"date","value":"Thu, 25 Oct 2018 22:00:23 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\"\n}"}],"_postman_id":"4576a95a-8c07-4068-9107-0e3c272ef588"},{"name":"Execute Cash Payment for Order","event":[{"listen":"test","script":{"id":"9bcd9865-06d2-4ed4-b0c6-37d4ca139f0a","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"`paymentMethod` is 'cash'\", function () {"," var json = pm.response.json();"," pm.expect(json.paymentMethod).to.eql('cash');","});","","pm.test(\"`orderID` matches environment variable\", function () {"," var json = pm.response.json();"," pm.expect(json.orderID).to.eql(pm.environment.get('order'));","});","",""],"type":"text/javascript"}}],"id":"6ebaa2a2-fe1d-4c3c-9f45-1ecbc158d8d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{cash_payment_token}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"currency\": \"usd\",\n\t\"shipping\": 3000,\n\t\"shippingDiscount\": 1200,\n\t\"handling\": 1500,\n\t\"insurence\": 2000,\n\t\"giftWrap\": 250\n}"},"url":"http://localhost:8082/v1/orders/{{order}}/payment/cash","description":"Creates a Payment object for an Order without interacting with an third-part payment provider. This can be used when tangible money is manually transfered from the customer to the seller.
Payments can be made for an Order resource using any one of the configured third-party payment providers. By default these are PayPal and Stripe.
Depending on the provider you use, you will have to follow different steps to create and execute the remote payment. For some, you call the create endpoint, and when that succeeded, you call execute. For others, you create the payment from the client and when that succeeds, you execute it. This is done when you need to pass credit card information to the provider and want to avoid it going through your server. This helps your app to remain PCI complient.
PayPal payments are made in two steps. First you create the payment, then you execute it.
\nAfter you create an Order, you can call the POST /orders/:order/payment/paypal/create route which will both create the payment with PayPal and an internal Payment instance. Once the payment is created, you can execute it with the POST /orders/:order/payment/paypal/execute route.
While you could say a Stripe payment is create with two steps, it only requires one on your service. First you need to create the payment with Stripe from your front-end. You can follow their quickstart guide to do that. You will want to set the credit card form’s action to the POST /orders/:order/payment/stripe-cc route and make sure the form data sends the required payment information in the request’s body.
You should end up with the form submission sending the Stripe credit card token, plus additional payment data, to your order service.
\n$5.50 USD, you would pass in 550.Used by an app's load balancer to check the health of the service.
\n","urlObject":{"protocol":"http","port":"8080","path":["v1","orders","health"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"5644e821-9499-44ef-9e8d-dd334b05535d","name":"Service Health","originalRequest":{"method":"GET","header":[],"url":"http://localhost:8080/v1/orders/health"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"content-type","value":"text/plain; charset=utf-8"},{"key":"content-length","value":"9"},{"key":"date","value":"Thu, 25 Oct 2018 21:11:54 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"All Good!"}],"_postman_id":"fafaf174-ebed-4453-a34a-6d7ecfed6ee6"}],"event":[{"listen":"prerequest","script":{"id":"84a4de3d-a9e4-47ca-8c4e-00d70d4e3aaf","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"678d69a9-36c8-4ceb-9c03-e5d9abd0a3cf","type":"text/javascript","exec":[""]}}],"variable":[{"key":"JWT_TOKEN","value":"REPLACE_ME"}]}