picanova_api

PicanovaApi - JavaScript client for picanova_api Picanova API documentation This SDK is automatically generated by the Swagger Codegen project:

• API version:
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install picanova_api --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your picanova_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('picanova_api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/picanova_api then install it via:

    npm install YOUR_USERNAME/picanova_api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var PicanovaApi = require('picanova_api');

var defaultClient = PicanovaApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new PicanovaApi.CountryApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.countriesGet(callback);

Documentation for API Endpoints

All URIs are relative to https://localhost/api/beta

Class	Method	HTTP request	Description
PicanovaApi.CountryApi	countriesGet	GET /countries	Get list of countries with name and country_id
PicanovaApi.OrdersApi	ordersGet	GET /orders	Show a list of all orders
PicanovaApi.OrdersApi	ordersOrderIdDelete	DELETE /orders/{order_id}	Cancel an order
PicanovaApi.OrdersApi	ordersOrderIdGet	GET /orders/{order_id}	Show an order
PicanovaApi.OrdersApi	ordersPost	POST /orders	Create an order
PicanovaApi.ProductsApi	productsGet	GET /products	Show products
PicanovaApi.ProductsApi	productsProductIdGet	GET /products/{product_id}	Show product's variants
PicanovaApi.RegionApi	regionsCountryIdGet	GET /regions/{country_id}	Get list of regions with name and country_id
PicanovaApi.ShippingApi	shippingMethodsGet	GET /shipping/methods	Show a list of all shipping methods
PicanovaApi.ShippingApi	shippingRatesPost	POST /shipping/rates	Calculate shipping rates
PicanovaApi.ShippingApi	shippingTypesGet	GET /shipping/types	Show a list of all shipping types

Documentation for Models

• PicanovaApi.InlineResponse200
• PicanovaApi.InlineResponse2001
• PicanovaApi.InlineResponse2001Data
• PicanovaApi.InlineResponse2002
• PicanovaApi.InlineResponse2002Data
• PicanovaApi.InlineResponse2003
• PicanovaApi.InlineResponse2004
• PicanovaApi.InlineResponse2005
• PicanovaApi.InlineResponse2005Data
• PicanovaApi.InlineResponse2006
• PicanovaApi.InlineResponse2006Data
• PicanovaApi.InlineResponse2007
• PicanovaApi.InlineResponse2007Data
• PicanovaApi.InlineResponse2008
• PicanovaApi.InlineResponse2008Data
• PicanovaApi.InlineResponse200Data
• PicanovaApi.OrderPost
• PicanovaApi.OrderPostItems
• PicanovaApi.OrderPostOptions
• PicanovaApi.OrderPostShipping
• PicanovaApi.ShippingItem
• PicanovaApi.ShippingPost
• PicanovaApi.ShippingPostShipping
• PicanovaApi.SingleOrder
• PicanovaApi.SingleOrderCreatedAt
• PicanovaApi.SingleOrderItems
• PicanovaApi.SingleOrderOptions
• PicanovaApi.SingleOrderPriceDetails
• PicanovaApi.SingleOrderShippingMethod
• PicanovaApi.SingleOrderTotals
• PicanovaApi.SingleOrderTotalsCustomsShippingCostsDetails
• PicanovaApi.SingleOrderTotalsShippingAmountDetails
• PicanovaApi.SingleOrderTotalsTotalAmountDetails
• PicanovaApi.SingleOrderValue

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication