Kunaki API

A convenience libarary for anyone integrating the Kunaki XML API.

Installation

NPM: npm install --save kunaki-api

Yarn: yarn add kunaki-api

Prerequisites

You will need to have an account with Kunaki, and products defined with them.

Usage

[!CAUTION] You probably should not use this library from the browser. API calls for placing and tracking orders require your Kunaki credentials, which would necessitate leaking that info.

This problem does not exist in backend/API code.

Methods

getShippingOptions()

Usage: getShippingOptions({ Destination: {}, Products: [] })

Destination object:

{
  State_Province: "New York",
  PostalCode: "90929",
  Country: "United States"  // must match on of the strings in the countriesList array (see below)
}

Products array:

[
  {
    ProductId: "838949",
    Quantity: 1
  },
  // ...
]

placeOrder()

Usage: placeOrder({ Auth: {}, Order: {}, Mode: "TEST" | "LIVE" })

Auth object:

{
  UserId: "kunaki-user-id",
  Password: "kunaki-password"
}

Order object:

{
  Name: "Fred Flintstone",
  Company: "Spacely Sprockets",
  Address1: "123 Rock St",
  Address2: "",
  City: "Bedrock",
  State_Province: "Somewhere",
  PostalCode: "12345",
  Country: "United States",
  Products: [
    { ProductId: "", Quantity: 1 }
  ],
  ShippingDescription: "USPS ground" // must match the name returned by the query above
}

Note: Set Mode = 'TEST' to test the API without placing a real order.

checkOrderStatus()

Usage: checkOrderStatus({ Auth: {}, OrderId: "" })

Auth object:

{
  UserId: "kunaki-user-id",
  Password: "kunaki-password"
}

Constants

countriesList

An array of the proper country names accepted by the Kunaki API.

countrySelectOptions

An array of { label, value } objects containing the values of countriesList, for convenience when using components (like React Select) which expect to have label/value pairs for the options attribute.