Shippo JavaScript SDK

Shippo is a shipping API that connects you with multiple shipping carriers (such as USPS, UPS, DHL, Canada Post, Australia Post, and many others) through one interface.

You must register for a Shippo account to use our API. It's free to sign up. Only pay to print a live label, test labels are free.

To use the API, you must generate an API Token. In the following examples, replace with your own token.

For example.
``
api_key_header="shippo_test_595d9cb0c0e14497bf07e75ecfec6c6d"
`





Summary

Shippo external API.: Use this API to integrate with the Shippo service





Table of Contents

* Shippo JavaScript SDK
* SDK Installation
* Requirements
* SDK Example Usage
* Standalone functions
* Retries
* Custom HTTP Client
* Debugging
* Documentation
* Available Resources and Operations
* Development
* Maturity
* Contributions
* About Shippo

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

$3

`bash
npm add shippo
`

$3

`bash
pnpm add shippo
`

$3

`bash
bun add shippo
`

$3

`bash
yarn add shippo
`





Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.


SDK Example Usage

$3

`typescript
import { Shippo } from "shippo";

const shippo = new Shippo({
apiKeyHeader: "",
// the API version can be globally set, though this is normally not required
// shippoApiVersion: "",
});

async function run() {
const result = await shippo.addresses.list();

// Handle the result
console.log(result);
}

run();

`









Standalone functions

All the methods listed above are available as standalone functions. These
functions are ideal for use in applications running in the browser, serverless
runtimes or other environments where application bundle size is a primary
concern. When using a bundler to build your application, all unused
functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

- addressesCreate - Create a new address
- addressesGet - Retrieve an address
- addressesList - List all addresses
- addressesValidate - Validate an address
- batchesAddShipments - Add shipments to a batch
- batchesCreate - Create a batch
- batchesGet - Retrieve a batch
- batchesPurchase - Purchase a batch
- batchesRemoveShipments - Remove shipments from a batch
- carrierAccountsCreate - Create a new carrier account
- carrierAccountsGet - Retrieve a carrier account
- carrierAccountsGetRegistrationStatus - Get Carrier Registration status
- carrierAccountsInitiateOauth2Signin - Connect an existing carrier account using OAuth 2.0
- carrierAccountsList - List all carrier accounts
- carrierAccountsRegister - Add a Shippo carrier account
- carrierAccountsUpdate - Update a carrier account
- carrierParcelTemplatesGet - Retrieve a carrier parcel templates
- carrierParcelTemplatesList - List all carrier parcel templates
- customsDeclarationsCreate - Create a new customs declaration
- customsDeclarationsGet - Retrieve a customs declaration
- customsDeclarationsList - List all customs declarations
- customsItemsCreate - Create a new customs item
- customsItemsGet - Retrieve a customs item
- customsItemsList - List all customs items
- manifestsCreate - Create a new manifest
- manifestsGet - Retrieve a manifest
- manifestsList - List all manifests
- ordersCreate - Create a new order
- ordersGet - Retrieve an order
- ordersList - List all orders
- parcelsCreate - Create a new parcel
- parcelsGet - Retrieve an existing parcel
- parcelsList - List all parcels
- pickupsCreate - Create a pickup
- ratesAtCheckoutCreate - Generate a live rates request
- ratesAtCheckoutDeleteDefaultParcelTemplate - Clear current default parcel template
- ratesAtCheckoutGetDefaultParcelTemplate - Show current default parcel template
- ratesAtCheckoutUpdateDefaultParcelTemplate - Update default parcel template
- ratesGet - Retrieve a rate
- ratesListShipmentRates - Retrieve shipment rates
- ratesListShipmentRatesByCurrencyCode - Retrieve shipment rates in currency
- refundsCreate - Create a refund
- refundsGet - Retrieve a refund
- refundsList - List all refunds
- serviceGroupsCreate - Create a new service group
- serviceGroupsDelete - Delete a service group
- serviceGroupsList - List all service groups
- serviceGroupsUpdate - Update an existing service group
- shipmentsCreate - Create a new shipment
- shipmentsGet - Retrieve a shipment
- shipmentsList - List all shipments
- shippoAccountsCreate - Create a Shippo Account
- shippoAccountsGet - Retrieve a Shippo Account
- shippoAccountsList - List all Shippo Accounts
- shippoAccountsUpdate - Update a Shippo Account
- trackingStatusCreate - Register a tracking webhook
- trackingStatusGet - Get a tracking status
- transactionsCreate - Create a shipping label
- transactionsGet - Retrieve a shipping label
- transactionsList - List all shipping labels
- userParcelTemplatesCreate - Create a new user parcel template
- userParcelTemplatesDelete - Delete a user parcel template
- userParcelTemplatesGet - Retrieves a user parcel template
- userParcelTemplatesList - List all user parcel templates
- userParcelTemplatesUpdate - Update an existing user parcel template
- webhooksCreateWebhook - Create a new webhook
- webhooksDeleteWebhook - Delete a specific webhook
- webhooksGetWebhook - Retrieve a specific webhook
- webhooksListWebhooks - List all webhooks
- webhooksUpdateWebhook - Update an existing webhook

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
`typescript
import { Shippo } from "shippo";

const shippo = new Shippo({
shippoApiVersion: "2018-02-08",
apiKeyHeader: "",
});

async function run() {
const result = await shippo.addresses.list({
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});

console.log(result);
}

run();

`

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
`typescript
import { Shippo } from "shippo";

const shippo = new Shippo({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
shippoApiVersion: "2018-02-08",
apiKeyHeader: "",
});

async function run() {
const result = await shippo.addresses.list();

console.log(result);
}

run();

`





Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a
custom header and a timeout to requests and how to use the "requestError" hook
to log errors:

`typescript
import { Shippo } from "shippo";
import { HTTPClient } from "shippo/lib/http";

const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native fetch.
fetcher: (request) => {
return fetch(request);
}
});

httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});

nextRequest.headers.set("x-custom-header", "custom value");

return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", ${error});
console.log("Endpoint:", ${request.method} ${request.url});
console.groupEnd();
});

const sdk = new Shippo({ httpClient: httpClient });
`





Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

> [!WARNING]
> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

`typescript
import { Shippo } from "shippo";

const sdk = new Shippo({ debugLogger: console });
``

Documentation

Review our full guides and references at https://docs.goshippo.com/.

Available Resources and Operations

Available methods

$3

* list - List all addresses
* create - Create a new address
* get - Retrieve an address
* validate - Validate an address

$3

* create - Create a batch
* get - Retrieve a batch
* addShipments - Add shipments to a batch
* purchase - Purchase a batch
* removeShipments - Remove shipments from a batch

$3

* list - List all carrier accounts
* create - Create a new carrier account
* get - Retrieve a carrier account
* update - Update a carrier account
* initiateOauth2Signin - Connect an existing carrier account using OAuth 2.0
* register - Add a Shippo carrier account
* getRegistrationStatus - Get Carrier Registration status

$3

* list - List all carrier parcel templates
* get - Retrieve a carrier parcel templates

$3

* list - List all customs declarations
* create - Create a new customs declaration
* get - Retrieve a customs declaration

$3

* list - List all customs items
* create - Create a new customs item
* get - Retrieve a customs item

$3

* list - List all manifests
* create - Create a new manifest
* get - Retrieve a manifest

$3

* list - List all orders
* create - Create a new order
* get - Retrieve an order

$3

* list - List all parcels
* create - Create a new parcel
* get - Retrieve an existing parcel

$3

* create - Create a pickup

$3

* get - Retrieve a rate
* listShipmentRates - Retrieve shipment rates
* listShipmentRatesByCurrencyCode - Retrieve shipment rates in currency

$3

* create - Generate a live rates request
* getDefaultParcelTemplate - Show current default parcel template
* updateDefaultParcelTemplate - Update default parcel template
* deleteDefaultParcelTemplate - Clear current default parcel template

$3

* create - Create a refund
* list - List all refunds
* get - Retrieve a refund

$3

* list - List all service groups
* create - Create a new service group
* update - Update an existing service group
* delete - Delete a service group

$3

* list - List all shipments
* create - Create a new shipment
* get - Retrieve a shipment

$3

* list - List all Shippo Accounts
* create - Create a Shippo Account
* get - Retrieve a Shippo Account
* update - Update a Shippo Account

$3

* create - Register a tracking webhook
* get - Get a tracking status

$3

* list - List all shipping labels
* create - Create a shipping label
* get - Retrieve a shipping label

$3

* list - List all user parcel templates
* create - Create a new user parcel template
* delete - Delete a user parcel template
* get - Retrieves a user parcel template
* update - Update an existing user parcel template

$3

* createWebhook - Create a new webhook
* listWebhooks - List all webhooks
* getWebhook - Retrieve a specific webhook
* updateWebhook - Update an existing webhook
* deleteWebhook - Delete a specific webhook

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

About Shippo

Connect with multiple different carriers, get discounted shipping labels, track parcels, and much more with just one integration. You can use your own carrier accounts or take advantage of our discounted rates with the Shippo carrier accounts. Using Shippo makes it easy to deal with multiple carrier integrations, rate shopping, tracking and other parts of the shipping workflow. We provide the API and web app for all your shipping needs.