Skip to main content

Shippo to iPaaS.com Carrier Service Mapping Documentation

How Shippo carrier services transfer TO iPaaS.com as shipping methods by initialization, scheduled poll or a label's prerequisite, and what each default mapping carries.

Summary

This documentation covers how the Shippo integration brings the carrier services of your active Shippo carrier accounts TO iPaaS.com as Shipping Method records, one per carrier and service, for example USPS Priority Mail. The sync type is Add/Update, so a carrier service brought in again updates its existing Shipping Method instead of creating a duplicate.

Load the Shipping Methods before labels. The Shippo Label collection depends on this one: iPaaS.com accepts a tracking record only when it names an existing Shipping Method. Each Shipping Method's description also shows the Shippo token to use in the Shippo Label Service translation, which chooses the service the order collection buys labels with.

ID Format

Manual Sync ID Format

The carrier code and the service token joined by |, for example usps|usps_priority.

External ID Format

The same value, saved on a separate external-ID record after a successful transfer. Later transfers of the service update the same Shipping Method.

Deleted Record Support

Not supported at the time this documentation was written. A service removed from Shippo, or a carrier account turned off, is no longer read, but its iPaaS.com Shipping Method is kept. Subscribers or their MiSP can remove it in iPaaS.com if it should no longer be offered; tracking for labels bought with a removed service then fails until the Shipping Method exists again.

Custom Field Support

Not supported. The collection writes the standard Shipping Method fields only.

Mapping Collection Status

  • Status: Enabled.

  • Trigger Events: Initialization (Initialize Data on the subscription) loads every service of every active carrier account. The shipping_method/poll scope reads them all again, adding new services and updating existing ones; it runs only from a Webhook Poll Request event created in iPaaS.com Events for this subscription, and each run transfers every service, often around two hundred for a full Shippo account, so schedule it rarely or run it when your carrier accounts change. The shipping_method/updated scope and Manual Sync transfer one service by its token. A label for a service that isn't in iPaaS.com yet also brings that service in first; validate this in a staging subscription before relying on it in production.

Duplicate or Conflicting Mappings

None. This is the only collection that writes Shippo carrier services to iPaaS.com Shipping Methods. Shipping Methods are shared by every subscription in your company: if another integration also writes Shipping Methods, check that the names don't collide.

Collision handling is not offered: a Shipping Method is matched only by its link to the Shippo carrier service.

No unmapped field overwrite risk: a Shipping Method field this collection doesn't map keeps its value when the service is transferred again.

Supported Child Collections

None. This is a standalone collection.

System Caveats

Shippo Caveats

  • Active carrier accounts only. Services of a carrier account turned off in Shippo are not read.

  • Every service each run. The integration reads the carrier accounts with their services and sends them all, so every poll or initialization transfers every service again.

  • Rate limiting. When Shippo limits the rate of calls, the transfer is held and resumes automatically; no action is needed.

iPaaS.com Caveats

  • A name is required. iPaaS.com refuses to create or update a Shipping Method without a name.

  • Tracking depends on these names. A tracking record must name an existing Shipping Method.

Setup Requirements

For full setup steps see the Installation Instructions and Connections and Settings articles. For this collection specifically:

  • Turn on the carrier accounts you ship with in Shippo.

  • Run Initialization for this collection once after installing, before the first label, and again after adding a carrier account in Shippo.

  • Optionally add a filter to keep only the carriers you use.

Integration Flow

  1. Initialization, the poll, the single-service scope, a Manual Sync, or a label for a service not yet in iPaaS.com starts the transfer.

  2. The integration reads your active Shippo carrier accounts with their services and builds one record per carrier and service: the carrier's name and the service name (for example USPS Priority Mail), the carrier code, the service token and the carrier account.

  3. Each record passes the collection's filter, is mapped, and is written TO iPaaS.com as an Add or an Update, matched by its link to the Shippo carrier service.

Mappings

Add/Update Shippo Carrier Service TO iPaaS.com

iPaaS.com data type: Shipping Method

Description: Writes each service of your active Shippo carrier accounts as an iPaaS.com Shipping Method.

No mapping filter is applied by default. To keep only the carriers you use, add one such as return Carrier == "usps" || Carrier == "ups";. A service the filter leaves out can't be used on tracking records.

Mapping Type

Source Field (Shippo)

Destination Field (iPaaS.com)

Description

Dynamic Formula

return Name;

Name

Required. The carrier's name and the service name, for example USPS Ground Advantage. Tracking records refer to the Shipping Method by this name.

Dynamic Formula

return "Label Service: " + Id;

Description

Recommended. Shows the service's token, for example Label Service: usps|usps_priority: the value to use in the Shippo Label Service translation.

Error Handling

Errors from this collection appear in iPaaS.com Dashboard / Integration Monitoring / Error Logs.

  • A Shipping Method refused because its name is missing reports iPaaS.com's required-field error.

  • SHPO-EXTN-1002: Shippo limited the rate of calls; the transfer is held and resumes automatically.

For the full catalog of error messages see the Shippo Error Messages article.

Testing & Validation

Test Scenarios

  1. Run Initialization. Verify one iPaaS.com Shipping Method per service of each active carrier account, each linked by its token (for example usps|usps_priority).

  2. Open one Shipping Method. Verify the name (for example USPS Priority Mail) and the description (for example Label Service: usps|usps_priority).

  3. Run a Manual Sync with one token. Verify only that Shipping Method is updated and no duplicate is created.

  4. Bring in a label for a service. Verify the tracking record names that service's Shipping Method.

Validation Checklist

  • Every carrier you ship with is active in Shippo.

  • Initialization has been run before the first label.

  • Any filter added to this collection still allows every service used on your labels and in the Shippo Label Service translation.

Related Documents

Did this answer your question?