Skip to content

Latest commit

 

History

History
155 lines (106 loc) · 3.71 KB

ShippingApi.md

File metadata and controls

155 lines (106 loc) · 3.71 KB
Raw

PicanovaApi.ShippingApi

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

Method HTTP request Description
shippingMethodsGet GET /shipping/methods Show a list of all shipping methods
shippingRatesPost POST /shipping/rates Calculate shipping rates
shippingTypesGet GET /shipping/types Show a list of all shipping types

shippingMethodsGet

InlineResponse2002 shippingMethodsGet()

Show a list of all shipping methods

Returns the available shipping methods

Example

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 apiInstance = new PicanovaApi.ShippingApi();

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

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse2002

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

shippingRatesPost

InlineResponse200 shippingRatesPost(body)

Calculate shipping rates

Returns the calculated shipping rates for the given items and shipping info

Example

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 apiInstance = new PicanovaApi.ShippingApi();

var body = new PicanovaApi.ShippingPost(); // ShippingPost | 


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

Parameters

Name Type Description Notes
body ShippingPost

Return type

InlineResponse200

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

shippingTypesGet

InlineResponse2001 shippingTypesGet()

Show a list of all shipping types

Returns the available shipping types

Example

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 apiInstance = new PicanovaApi.ShippingApi();

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

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse2001

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined