kjaenicke / shipstation-node

Unofficial Node.js Wrapper for Shipstation API

Hello there 👋, I'm Keenan Jaenicke

Software Engineer based outta Indy!

• 🤝 I’m looking for help with shipstation-node

shipstation-node's Issues

advancedOptions type is wrong: map instead of array

List of carrier codes?

Does anyone have a complete list of carrier codes?

Also, I know this is more of a question for shipstation, but maybe it will help somebody else just picking this package up-- I've been playing around on postman and seem to be getting: "No applicable services were available for the configured shipment" for almost all my attempts, other than from stamps_com... do we need to configure other carriers to get their rates?

e.g. this returns no rates result

{
  "carrierCode": "fedex",
  "fromPostalCode": "03801",
  "toPostalCode": "90712",
  "weight": {
    "value": 60,
    "units": "pounds"
  },
  "toCountry": "US"
}

Is it just that fedex truly can't handle this delivery between these area codes or is this a matter of configuring the provider/carrier in my settings?

The same options but with stamps_com does return rates

{
  "carrierCode": "stamps_com",
  "fromPostalCode": "03801",
  "toPostalCode": "90712",
  "weight": {
    "value": 60,
    "units": "pounds"
  },
  "toCountry": "US"
}

Lastly, has anyone found a pattern for which carriers top out in terms of weight? I noticed stamps_com seems to max around around 70-80 pounds for most of the combinations I've tried.

and, of course, thanks for publishing this.

TypeScript duplicate warning: ...node_modules/shipstation-node/dist/index.js' imported multiple times import/no-duplicates

It is a warning, so not breaking, but would like it to go away, without having to suppress the warning.

When deploying to Google Cloud Functions, the following warning is displayed in logs.

/home/me/AndroidStudioProjects/order_fulfillment/functions/src/lib/helperFunctions.ts
   10:25  warning  '/home/me/AndroidStudioProjects/order_fulfillment/functions/node_modules/shipstation-node/dist/index.js' imported multiple times  import/no-duplicates
  112:28  warning  '/home/me/AndroidStudioProjects/order_fulfillment/functions/node_modules/shipstation-node/dist/index.js' imported multiple times  import/no-duplicates

I'm importing both ShipStation and ShipStationAPI so I can set the Promise return type.

In my helperFunctions.ts I'm importing shipstation-node by doing the following:

import ShipStation from 'shipstation-node'
import ShipStationAPI from 'shipstation-node'

/**
 * Set the ShipStation API client.
 * https://github.com/kjaenicke/shipstation-node
 * @return {ShipStationAPI | null} The ShipStation client.
 */
export async function setShipStationClient(): Promise<ShipStationAPI | null> {
  try {
    return new ShipStation({
      apiKey,
      apiSecret,
      retry: { retries: 3 },
    })
  } catch (error) {
    functions.logger.error(error)
    return null
  }
}

What is the role of typedi in this project?

It seems to be unnecessary for a clean abstraction.

And feels like should be more of a project dependency.

Thanks.

Publish the types to @types

Thanks for creating the ShipStation types, have you thought about publishing the types to @types?
https://github.com/DefinitelyTyped/DefinitelyTyped#how-can-i-contribute

If not, do you mind if I do?

license

Hi.
Your package looks great. can you add a license to it? I want to know if I can fork it
thanks

Shipments getAll Return Type is incorrect

Hey, first of all, thank you for all of work on this, it's been really helpful!

When attempting to use shipments.getAll, I noticed that the return type of the method is Promise<IShipment[]> when it should be Promise<IShipmentPaginationResult> (which doesn't currently exist) similar to the orders.getAll return. Because of this, attempting to access shipments from the returned object fails. I was able to work around it by importing your models and creating my own:

  interface IShipmentPaginatedResults extends Models.IPaginatedResult {
    shipments: Models.IShipment[];
  }

and then casting the results

  const { shipments, page, pages } = (await shipstation.shipments.getAll({
    pageSize: 500,
    shipDateStart: orderDateStart,
  })) as unknown as IShipmentPaginatedResults 

Just wanted to give you a heads up. Thanks again!

--DJ

Any chance you could add support for listing orders by tag?

This is a great library and has really helped speed up my integration with ShipStation. However, I need to use "List By Tag" and don't see how to do it with your library. Can it be added?

https://www.shipstation.com/docs/api/orders/list-by-tag/

Thanks!

Add Jest for Testing