Skip to content
This repository was archived by the owner on Apr 15, 2025. It is now read-only.

kjaenicke/shipstation-node

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

103 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

[DEPRECATED] shipstation-node

⚠️ The repository for shipstation-node has moved to https://github.com/rip-technologies/shipstation-node

This repo has been deprecated and is no longer maintained.

Usage

  • Set the following env variables for our ShipStation account:
    • SHIPSTATION_API_KEY (your ShipStation API Key)
    • SHIPSTATION_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.list();

// Get order by id
const order = await shipstation.orders.get(1244);
  • Optionally, set ShipStation credentials through the options:
    • apiKey (your ShipStation API Key)
    • apiSecret (your ShipStation API secret)
const shipstation = new ShipStation({
  apiKey: '<key>',
  apiSecret: '<secret>'
});
  • Optionally, Retry ShipStation API failures via:
    • Set retry true to enable default options
    • OR provide an object with any options supported by axios-retry
const shipstation = new ShipStation({
  // default retry config
  retry: true,

  // OR custom
  retry: { retries: 3 }
});

About

Unofficial Node.js Wrapper for ShipStation API

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors