Envoi

Ensure you have provided required credentials to ship with Envoi.

Envoi credential requirements

Prior to shipping with Envoi, you must configure credentials in the Shipium Console. You'll provide an API key and a child user name for both test mode and production.

In addition to providing credentials for your Envoi account, you also must work with your Envoi carrier representative to configure three packaging attributes for successful integration with the Shipium system:

  • Width number. The package container width; this should be configured to units of inches.
  • Weight number. The package weight; this should be configured to units of pounds.
  • ZPL string. ZPL string composing the Envoi ZPL shipping label; this is only available when the ZPL label option is enabled. This option should be enabled in order to receive ZPL labels in your API call response.

Configuring the width in inches and the weight in pounds does not preclude passing values of kilograms or centimeters in your calls to Shipium's APIs for package weight or size, respectively. The Shipium system will convert the values to the appropriate unit, but the units must be configured as outlined above with Envoi.

Resources

Your Shipium team member is available to help along the way. However, you might find these resources helpful: