npm install shipengine
The only configuration requirement is an API key.
const ShipEngine = require("shipengine"); const shipengine = new ShipEngine("___YOUR_API_KEY_HERE__");
createLabelFromRate- When retrieving rates for shipments using the
getRatesWithShipmentDetailsmethod, the returned information contains a
rateIdproperty that can be used to purchase a label without having to refill in the shipment information repeatedly.
createLabelFromShipmentDetails- Purchase and print a label for shipment.
getRatesWithShipmentDetails- Given some shipment details and rate options, this method returns a list of rate quotes.
listCarriers- Returns a list of carrier accounts that have been connected through the ShipEngine dashboard.
trackUsingLabelId- Track a package by its associated label ID.
trackUsingCarrierCodeAndTrackingNumber- Track a package for a given carrier and tracking number.
validateAddresses- Indicates whether the provided addresses are valid. If the addresses are valid, the method returns a normalized version based on the standards of the country in which the address resides. If an address cannot be normalized, an error is returned.
voidLabelWithLabelId- Void a label with its Label ID.
Contributions, enhancements, and bug-fixes are welcome! Open an issue on GitHub and submit a pull request.
To build the project locally on your computer:
Clone this repo
git clone https://github.com/ShipEngine/shipengine-js.git
Build the code
npm run build
Or you can use
npm run watchto automatically re-build whenever source files change.
Lint the code
npm run lint
Or you can use
npm run lint:fixto automatically fix most linting errors.
Run the tests
This runs tests in both Node.js and web browsers. Use
npm run test:nodeto only run Node.js tests, or
npm run test:browserto only run browser tests.
This project adheres to the Conventional Commits specification.
Publishing new versions of the SDK to NPM is handled on GitHub via the Release Please GitHub Actions workflow. Learn more about about Release PRs, updating the changelog, and commit messages here.