@agnostack/shipstation-request

🎮 Minimal ShipStation API request library for Node

Installation

yarn add @agnostack/shipstation-request  # npm install @agnostack/shipstation-request

Quickstart (OAuth)

const { createClient } = require('@agnostack/shipstation-request');
// import { createClient } from '@agnostack/shipstation-request'

// NOTE: You'll need to generate an API Key and API Secret under
//   Account Settings > Account > API Settings > Generate New API Keys
const shipstation = new createClient({
  public_key: '...', // Shipstation API Key
  secret_key: '...' // Shipstation API Secret
});

shipstation
  .get('/carriers')
  .then(console.log)
  .catch(console.error);

shipstation
  .post('/shipments/getrates', {
    carrierCode: 'fedex',
    serviceCode: null,
    packageCode: null,
    fromPostalCode: '78703',
    toState: 'DC',
    toCountry: 'US',
    toPostalCode: '20500',
    toCity: 'Washington',
    weight: {
      value: 3,
      units: 'ounces'
    },
    dimensions: {
      units: 'inches',
      length: 7,
      width: 5,
      height: 6
    },
    confirmation: 'delivery',
    residential: false
  })
  .then(console.log)
  .catch(console.error);

shipstation
  .get(`/orders`)
  .then(console.log)
  .catch(console.error);

Kitchen sink

const shipstation = new createClient({
  public_key: '...',
  secret_key: '...',
  application: '...',
  headers: {
    // ...
  }
});

Custom headers per request

The API provides you the ability to send various request headers that change the way data is stored or retrieved.

By default this library will encode all data as JSON, however you can customise this by setting your own Content-Type header as an additional argument to get, patch, post, put and delete.

Note: If you add the Content-Type custom header to patch, post, put or delete you will need to encode data yourself.

const shipstation = new createClient({
  public_key: '...',
  secret_key: '...'
});

const headers = {
  'X-My-Header': 'custom'
};

shipstation
  .get('/carriers', headers)
  .then(console.log)
  .catch(console.error);

Contact Adam Grohs @ agnoStack for any questions.