Endpoints to be CreatedMonday, June 27, 2016 12:18 AM
To integrate with Bidco, the website developer must define and expose webservice endpoints for the following calls:
- getProducts – retrieves product details after scanning a tag
- calculateCosts – determines tax, shipping, and total cost
- processOrders – creates an order, with or without payment details included
- confirmPayment – updates an order with payment info.
Headers for each endpoint shall be:
Accept : application/json Content-Type: application/json
The endpoints to be created are as follows:
|API Method||Request Type||Endpoint URL to create||Role|
||Enables the retrieval of product title, images, description, options and pricing.|
||For a given product or products, calculates the shipping and tax cost, to get total order cost.|
||Creates an order in the merchant ecommerce platform. May or may not include payment information, depending on the checkout strategy (see below).|
||In the Hosted Payment with Order ID Strategy (see below), the Powa server tells the merchant ecommerce platform the results of the payment gateway transaction.|
<shopURL> is the URL where the merchant’s store resides. This may be a simple domain name (myshop.com), a domain with prefix (www.myshop.com), or a domain with path (www.myshop.com/catalog).
Ideally, production systems should ALWAYS utilize the secure https:// protocol for the API calls, though http:// is available for testing purposes.
Request bodies are defined in the JSON examples for each method call.