bm-vslice-ecommerce-layered-client-purchaseorders-pipservices-node
v1.0.3
Published
This is a Node.js client SDK for [service-purchaseorders-pipservices-node](https://bitbucket.org/entinco/bm-vslice-ecommerce-layered) microservice. It provides an easy to use abstraction over communication protocols:
Downloads
2
Readme
Payments Microservice Client SDK for Node.js
This is a Node.js client SDK for service-purchaseorders-pipservices-node microservice. It provides an easy to use abstraction over communication protocols:
- Direct client
- HTTP client
- Seneca client (see http://www.senecajs.org)
- AWS Lambda client (see https://aws.amazon.com/lambda)
Quick Links:
Install
Add dependency to the client SDK into package.json file of your project
{
...
"dependencies": {
....
"bm-vslice-ecommerce-layered-client-purchaseorders-pipservices-node": "^1.0.*",
...
}
}
Then install the dependency using npm tool
# Install new dependencies
npm install
# Update already installed dependencies
npm update
Use
Inside your code get the reference to the client SDK
var sdk = new require('bm-vslice-ecommerce-layered-client-purchaseorders-pipservices-node');
Define client configuration parameters that match configuration of the microservice external API
// Client configuration
var config = {
connection: {
protocol: 'http',
host: 'localhost',
port: 8080
}
};
Instantiate the client and open connection to the microservice
// Create the client instance
var client = sdk.PurchaseOrdersHttpClientV1(config);
// Connect to the microservice
client.open(null, function(err) {
if (err) {
console.error('Connection to the microservice failed');
console.error(err);
return;
}
// Work with the microservice
...
});
Now the client is ready to perform operations
// Create a new purchase_order
var purchase_order = {
id: '1',
user_session_id: '1',
currency_code: 'USD',
total: 100,
state: PurchaseOrderStateV1.New,
items: [{
price: 40,
product_id: 'product-1',
product_name: 'product name 1',
quantity: 2,
total: 80,
description: 'desctiption for product 1',
},
{
price: 20,
product_id: 'product-2',
product_name: 'product name 2',
quantity: 1,
total: 20,
description: 'desctiption for product 2',
}]
};
client.createOrder(
null,
purchase_order,
function (err, purchase_order) {
...
}
);
// Get the list of purchase_orders
client.getOrders(
null,
{
user_session_id: '1',
state: 'new'
},
{
total: true,
skip: 0,
take: 10
},
function(err, page) {
...
}
);
Contacts
This repository was created by and is currently maintained by Dmitriy Krayniy and Denis Kuznetsov.