ShipEngine Connector FAQs

These frequently asked questions cover the most common setup, daily use, and troubleshooting topics for the TeqStars ShipEngine Connector. For a full feature list, see ShipEngine Connector Features.

Getting Started

It connects Odoo to multiple shipping carriers through one ShipEngine integration. Odoo sends order details to ShipEngine and gets shipping labels, tracking numbers, and real-time rates back. You can also cancel shipments in ShipEngine from Odoo.

Yes. You can connect and set up multiple ShipEngine accounts in your Odoo database.

Yes. You can configure delivery methods for both local and global shipments. Each imported service shows whether it is Domestic ? or International ?. For international shipments, the connector can generate a commercial invoice.

Setup

  1. Create a shipping partner record and choose the ShipEngine option.

  2. Enter your ShipEngine key in API Key.

  3. Click Retrieve Available Carrier to import your carriers.

Details: Configure ShipEngine Connector.

Open the imported carrier and click Get Services and Get Packages. Then use the Services and Packages buttons to see what was imported.

Each carrier shows its Name, ID, Code, and Provider. It also shows Primary, Requires Funded Amount?, Balance, Multi-Package Support?, and Support Label Message?.

Create a delivery method and choose Ship Engine as its provider. Choose configured Shipping Partner. Then open the Configuration tab and set:

  • Carrier and Default Package Type.

  • Confirmation, Shipment Content Type, and Non Delivery.

  • Weight Unit and Dimension Unit.

  • Insurance Provider.

  • Saturday Delivery, Non Machinable, Delivery Duty Paid, and Is a Commercial Invoice Required? as needed.

Details: Configure ShipEngine Connector.

Confirmation sets the type of delivery confirmation that the shipment needs. The options are None, Delivery, Signature, Adult Signature, Direct Signature, Delivery Mail, and Verbal Communication.

Shipment Content Type sets the type of contents in the shipment: Merchandise, Documents, Gift, Returned Goods, or Sample. This may affect import duties or customs treatment. Non Delivery tells the carrier what to do if a package cannot be delivered: Return To Sender or Treat As Abandoned.

Weight Unit supports Kilogram, Pound, Ounce, and Gram. Dimension Unit supports Inch and Centi Meter (cm).

Insurance Provider sets who insures any insured packages in the shipment. The options are Carrier, Shipsurance, and Third Party.

  • Saturday Delivery enables Saturday delivery, if the carrier supports it.

  • Non Machinable marks a package that is too large or irregularly shaped to process automatically. It is mainly for USPS shipments.

  • Delivery Duty Paid means you pay the international delivery duties. UPS, FedEx, and DHL Express support this option.

Daily Use

Choose your ShipEngine delivery method on the sales order. The ShipEngine Carriers tab lists the available services. Each one shows its Shipengine Service, Shipengine Carrier, Delivery Time, Shipping Amount, Insurance Amount, and Total Charges. Pick the best option and click Add to order.

Yes. After you select the carrier on the delivery order, use the Get Rates button next to it to fetch rates and choose a service.

The connector generates the shipping label automatically. It also generates the commercial invoice when that is turned on. The chatter shows “Shipment created!” with the tracking numbers. The delivery order also stores the ShipEngine Tracking URL(s) and the Label Id.

Yes. Use the Put in Pack operation on the delivery order to split the goods into several packages. Tracking and shipping information is shown for single and multiple parcels.

Turn on Is a Commercial Invoice Required? on the delivery method. When the label is created, ShipEngine’s commercial invoice is attached to the delivery order with the label.

Open the delivery order and use the ShipEngine Tracking URL(s). This shows the status and location of your order.

Yes. You can cancel the shipment in ShipEngine from the delivery order with a single click. The chatter then shows “Shipment #… has been cancelled”.

Troubleshooting

The connector cannot find a ShipEngine account to import carriers from. Check that your shipping partner record uses the ShipEngine option and that its API Key is filled in. Then click Retrieve Available Carrier again.

The key in API Key is not a valid API key. Enter your ShipEngine production key and retrieve the carriers again.

No ShipEngine service is selected for the delivery order. Click Get Rates, next to the carrier on the delivery order, and select a service.

The weight unit is not supported by carrier or service. Check the Weight Unit on the delivery method.

Odoo could not get a valid reply from ShipEngine. The message includes the error details. Check your API Key and try again. If the error does not go away, contact support. See ShipEngine Connector Support Policy.