brandon93s / shipstation-node

Unofficial Node.js Wrapper for Shipstation API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

shipstation-node

Unofficial Shipstation API Wrapper for Node.js

This project is currently a work in progress and contributors are welcome! đź‘‹

Usage

  • Set the following env variables for our Shipstation account:
    • SS_API_KEY (your Shipstation API Key)
    • SS_API_SECRET (your Shipstation API secret)
import ShipStation from 'shipstation-node'

// Create instance
const shipstation = new ShipStation()

// Get all orders
const orders = await shipstation.orders.getAll()

// Get order by id
const order = await shipstation.orders.get(1244)
  • Optionaly, set Shipstation credentials through the options:
    • apiKey (your Shipstation API Key)
    • apiSecret (your Shipstation API secret)
const shipstation = new ShipStation({
  apiKey: '<key>',
  apiSecret: '<secret>'
})

About

Unofficial Node.js Wrapper for Shipstation API

License:MIT License


Languages

Language:TypeScript 100.0%