infoplus-javascript-client v1.0.0

infoplus-javascript-client

Infoplus is a cloud platform to manage your inventory, orders, warehouse, and shipments.

The Infoplus API exposes the full breadth and depth of the Infoplus platform to all clients. With the Infoplus API, you can integrate Infoplus functionality into other platforms (e.g. your ERP, shopping cart, accounting system, etc.), enabling you to do, in your own platform, anything you can do in Infoplus.

This repository is a native JavaScript client for full access to the Infoplus API.

Infoplus API Resources

The Resources listed below will provide all the information you need to integrate with the Infoplus API.

Developer's Home Page

https://www.infopluscommerce.com/developers/

• This site gives you an overview of the Infoplus API.
• Get a general understanding of the API and quick steps on getting started.

Infoplus API Reference Site

http://developers.infopluscommerce.com/

• The Infoplus API is a modern JSON + REST API, and the API Reference Site is the complete documentation of all endpoints, resources, and fields available in the API.
• Whether you're using the API directly over HTTPS, or if you're using a pre-built Client Library like this one, the API Reference Site gives you the specific details you need for each API call available, along with live demo capabilities.
• The API Reference Site also lets you request access to a free Demo Account to test out the API.

Have Questions?

• Read an Overview of the Infoplus API
• Get in touch with the Infoplus Support Team
• Visit the Infoplus API Forum

JavaScript Client Details

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 infoplus-javascript-client --save

git

If the library is hosted at a git repository, e.g. https://github.com/infopluscommerce/infoplus-javascript-client then install it via:

npm install infopluscommerce/infoplus-javascript-client --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):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

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

var infoplus = require('infoplus-javascript-client');

var defaultClient = infoplus.ApiClient.default;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"


var api = new infoplus.AisleApi()

var body = new infoplus.Aisle(); // {Aisle} Aisle to be inserted.


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

Documentation for API Endpoints

All URIs are relative to *https://${YOUR_DOMAIN}/infoplus-wms/api

Documentation for Models

• infoplus.Aisle
• infoplus.Alert
• infoplus.ApiResponse
• infoplus.Asn
• infoplus.BillOfLading
• infoplus.BillOfLadingCarrierInfoLine
• infoplus.BillOfLadingOrderInfoLine
• infoplus.BillingCode
• infoplus.BillingCodeType
• infoplus.Building
• infoplus.BusinessTransaction
• infoplus.Carrier
• infoplus.CarrierService
• infoplus.Carton
• infoplus.CartonContent
• infoplus.CartonType
• infoplus.Customer
• infoplus.EmailTemplate
• infoplus.ExternalShipment
• infoplus.FulfillmentPlan
• infoplus.FulfillmentProcess
• infoplus.IntegrationPartner
• infoplus.InventoryAdjustment
• infoplus.InventoryDetail
• infoplus.Item
• infoplus.ItemAccountCode
• infoplus.ItemBuyer
• infoplus.ItemLegacyLowStockContact
• infoplus.ItemLowStockCode
• infoplus.ItemMajorGroup
• infoplus.ItemProductCode
• infoplus.ItemReceipt
• infoplus.ItemSubGroup
• infoplus.ItemSummaryCode
• infoplus.JobTime
• infoplus.JobType
• infoplus.LineOfBusiness
• infoplus.Location
• infoplus.LocationAddressScheme
• infoplus.LocationBillingType
• infoplus.LocationFootprint
• infoplus.LoggedTime
• infoplus.LoggedTimeType
• infoplus.LowStock
• infoplus.Order
• infoplus.OrderLine
• infoplus.OrderLoadProgram
• infoplus.OrderSource
• infoplus.OrderSourceReservation
• infoplus.OverrideReturnAddress
• infoplus.ParcelAccount
• infoplus.ParcelShipment
• infoplus.PickFaceAssignment
• infoplus.ProductType
• infoplus.ProductionLot
• infoplus.QuickAdjustment
• infoplus.QuickReceipt
• infoplus.ReceivingProcess
• infoplus.ReceivingWorksheet
• infoplus.ReceivingWorksheetLineItem
• infoplus.ReceivingWorksheetPutAwayPlan
• infoplus.Replenishment
• infoplus.ReplenishmentPlan
• infoplus.ReplenishmentProcess
• infoplus.ServiceType
• infoplus.ShoppingCartConnection
• infoplus.ThirdPartyParcelAccount
• infoplus.User
• infoplus.Vendor
• infoplus.VendorComplianceSurvey
• infoplus.Warehouse
• infoplus.WarehouseDocument
• infoplus.WarehouseDocumentType
• infoplus.Work
• infoplus.WorkBatch
• infoplus.Zone

Documentation for Authorization

api_key

• Type: API key
• API key parameter name: API-Key
• Location: HTTP header