Shippo

Adds batch shipments to an existing batch.

Creates a new address object. You can use address objects to create new shipments, calculate rates, and to create orders.

Creates a new batch object for purchasing shipping labels for many shipments at once. Batches are created asynchronously. This means that the API response won't include your batch shipments yet. You need to retrieve the batch later to verify that all batch shipments are valid.

Creates a new carrier account or connects an existing carrier account to the Shippo account.

Creates a new customs declaration object

Creates a new customs item object.

Initiates a live rates request. Include either the object ID for an existing address record or a fully formed address object when entering an address value. You can also enter the object ID of an existing user parcel template or a fully formed user parcel template object as the parcel value.

Creates a new manifest object.

Creates a new order object.

Creates a new parcel object.

Creates a pickup object. This request is for a carrier to come to a specified location to take a package for shipping.

Creates a new refund object.

Creates a new service group.

Creates a new shipment object.

Creates a new <a href="https://docs.goshippo.com/docs/platformaccounts/platform_using_accounts/">Shippo Managed Account</a>.

Registers a webhook that will send HTTP notifications to you when the status of your tracked package changes. For more details on creating a webhook, see our guides on <a href="https://docs.goshippo.com/docs/tracking/webhooks/">Webhooks</a> and <a href="https://docs.goshippo.com/docs/tracking/tracking/">Tracking</a>.

Creates a new transaction object and purchases the shipping label using a rate object that has previously been created. <br> OR <br> Creates a new transaction object and purchases the shipping label instantly using shipment details, an existing carrier account, and an existing service level token.

Creates a new user parcel template. <br>You can choose to create a parcel template using a preset carrier template as a starting point, or you can create an entirely custom one. To use a preset carrier template, pass in a unique template token from <a href="/shippoapi/public-api/parcel-templates">this list</a> plus the weight fields (**weight** and **weight_unit**). Otherwise, omit the template field and pass the other fields, for the weight, length, height, and depth, as well as their units."

Creates a new webhook to send notifications to a URL when a specific event occurs.

Clears the currently configured default parcel template for live rates.

Deletes an existing service group using an object ID.

Deletes a user parcel template using an object ID.

Deletes a specific webhook using the webhook object ID.

Returns an existing address using an object ID.

Returns a batch using an object ID. <br> Batch shipments are displayed 100 at a time. You can iterate through each `page` using the `?page= query` parameter. You can also filter based on batch shipment status, for example, by passing a query param like `?object_results=creation_failed`. <br> For more details on filtering results, see our guide on <a href="https://docs.goshippo.com/docs/api_concepts/filtering/" target="blank"> filtering</a>.

Returns an existing carrier account using an object ID.

Fetches the parcel template information for a specific carrier parcel template, identified by the token.

Returns the registration status for the given account for the given carrier

Returns an existing customs declaration using an object ID

Returns an existing customs item using an object ID

Retrieve and display the currently configured default parcel template for live rates.

Returns an existing manifest using an object ID.

Retrieves an existing order using an object ID.

Returns parcel details using an existing parcel object ID (this will not return parcel details associated with un-purchased shipment/rate parcel object IDs).

Returns an existing rate using a rate object ID. Rates older than 390 days are not returned.

Returns an existing rate using a rate object ID.

Returns an existing shipment using an object ID. Shipment objects older than 390 days are not returned.

Returns a Shippo Managed Account using an object ID.

Returns the tracking status of a shipment using a carrier name and a tracking number.

Returns an existing transaction using an object ID.

Returns the parcel template information for a specific user parcel template, identified by the object ID.

Returns the details of a specific webhook using the webhook object ID.

Used by client applications to setup or reconnect an existing carrier account with carriers that support OAuth 2.0

Returns a list of all address objects that have been created in this account.

Returns a list of all carrier accounts connected to your Shippo account. These carrier accounts include both Shippo carrier accounts and your own carrier accounts that you have connected to your Shippo account. Additionally, you can get information about the service levels associated with each carrier account by passing in the `?service_levels=true` query parameter. <br> Using it appends the property `service_levels` to each carrier account. <br> By default, if the query parameter is omitted, the `service_levels` property will not be included in the response.

List all carrier parcel template objects. <br> Use the following query string params to filter the results as needed. <br> <ul> <li>`include=all` (the default). Includes templates from all carriers </li> <li>`include=user`. Includes templates only from carriers which the user has added (whether or not they're currently enabled) </li> <li>`include=enabled`. includes templates only for carriers which the user has added and enabled </li> <li>`carrier=*token*`. filter by specific carrier, e.g. fedex, usps </li> </ul>

Returns a list of all customs declaration objects

Returns a list all customs items objects.

Returns a list of all manifest objects.

Returns a list of all order objects.

Returns a list of all parcel objects.

Returns a list all refund objects.

Returns a list of service group objects.

Returns a paginated list of rates associated with a shipment. Rates for shipments older than 390 days are not returned.

Returns all available shipping rates for a shipment object. When you create a new valid shipment object, Shippo automatically calculates all available rates. Depending on your shipment data, there may be none, one or multiple rates. By default, the calculated rates will return the price in two currencies under the `amount` and `amount_local` keys, respectively. The `amount` key will contain the price of a rate expressed in the currency that is used in the country from where the parcel originates, and the `amount_local` key will contain the price expressed in the currency that is used in the country the parcel is shipped to. You can request rates with prices expressed in a different currency by adding the currency code to the end of the resource URL. The full list of supported currencies along with their codes can be viewed on <a href="http://openexchangerates.org/api/currencies.json">open exchange rates</a>. Note: re-requesting the rates with a different currency code will re-queue the shipment (i.e. set the Shipment's `status` to `QUEUED`) and the converted currency rates will only be available when the Shipment's `status` is set to `SUCCESS`. Rates for shipments older than 390 days are not returned.

Returns a list of all shipment objects.<br><br> In order to filter results, you must use the below path parameters. Provided dates should be ISO 8601 UTC dates (timezone offsets are currently not supported).<br><br> Optional path parameters:<br> `object_created_gt`- object(s) created greater than a provided date time<br> `object_created_gte` - object(s) created greater than or equal to a provided date time<br> `object_created_lt` - object(s) created less than a provided date time<br> `object_created_lte` - object(s) created less than or equal to a provided date time<br> Date format examples:<br> `2017-01-01`<br> `2017-01-01T03:30:30` or `2017-01-01T03:30:30.5`<br> `2017-01-01T03:30:30Z`<br><br> Example URL:<br> `https://api.goshippo.com/shipments/?object_created_gte=2017-01-01T00:00:30&object_created_lt=2017-04-01T00:00:30`<br><br> Note: Shipment objects older than 390 days are not returned.

Returns a list of Shippo Managed Accounts objects.

Returns a list of all transaction objects.

Returns a list all of all user parcel template objects.

Returns a list of all webhooks you have created.

Purchases an existing batch with a status of `VALID`. Once you send a POST request to the purchase endpoint the batch status will change to `PURCHASING`. When all the shipments are purchased, the status will change to `PURCHASED` and you will receive a `batch_purchased` webhook indicating that the batch has been purchased

Adds a Shippo carrier account

Removes shipments from an existing batch shipment.

Updates an existing carrier account object. The account_id and carrier can't be updated. This is because they form the unique identifier together.

Update the currently configured default parcel template for live rates. The object_id in the request payload should identify the user parcel template to be the new default.

Updates an existing service group object. <br>The object_id cannot be updated as it is the unique identifier for the object.

Updates a Shippo Managed Account using an object ID.

Updates an existing user parcel template.

Updates an existing webhook using the webhook object ID.

Validates an existing address using an object ID