Connecting to ShipEngine

Using API Key Authentication

ShipEngine uses API Key authentication to control access to its service.

To obtain your ShipEngine API Key:

1. Log into your ShipEngine account at https://app.shipengine.com.
2. Navigate to API Management at https://app.shipengine.com/#/portal/apimanagement.
3. Copy an existing API key or create a new one.

After obtaining your API Key, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your ShipEngine API Key.

Example Connection String

Profile=C:\profiles\ShipEngine.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

Connecting to ShipEngine

Once the authentication is configured, you can connect to ShipEngine and query data from any of the available tables such as Shipments, Labels, Carriers, and Warehouses.

Available Tables

The ShipEngine API Profile provides access to the following tables:

• Batches: Retrieve all batches
• BatchErrors: Retrieve all errors for a given batch (requires BatchId)
• Carriers: Retrieve a list of available carriers
• CarrierOptions: Retrieve all options for a given carrier (requires CarrierId)
• CarrierServices: Retrieve all services for a given carrier (requires CarrierId)
• CustomPackageTypes: List the custom package types associated with the account
• Labels: Retrieve all labels
• Manifests: Retrieve all manifests
• Shipments: Retrieve all shipments
• ShipmentRates: Retrieve all rates for a given shipment (requires ShipmentId)
• Tags: Retrieve all tags
• Warehouses: Retrieve all warehouses
• Webhooks: Retrieve a list of active webhooks

Important Notes

• Several child tables require a parent identifier to be specified as a filter: BatchErrors requires BatchId, CarrierOptions and CarrierServices require CarrierId, ShipmentRates requires ShipmentId.
• Date fields use ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.fffZ).

API Documentation

For more information about the ShipEngine API, see the official ShipEngine API documentation.

Usage Examples

Batches:

SELECT * FROM Batches

BatchErrors:

SELECT * FROM BatchErrors WHERE BatchId = 'your_batch_id'

Carriers:

SELECT * FROM Carriers

CarrierOptions:

SELECT * FROM CarrierOptions WHERE CarrierId = 'your_carrier_id'

CarrierServices:

SELECT * FROM CarrierServices WHERE CarrierId = 'your_carrier_id'

CustomPackageTypes:

SELECT * FROM CustomPackageTypes

Labels:

SELECT * FROM Labels

Manifests:

SELECT * FROM Manifests

Shipments:

SELECT * FROM Shipments

ShipmentRates:

SELECT * FROM ShipmentRates WHERE ShipmentId = 'your_shipment_id'

Tags:

SELECT * FROM Tags

Warehouses:

SELECT * FROM Warehouses

Webhooks:

SELECT * FROM Webhooks

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

---

Property	Description
APIKey	Your ShipEngine API Key.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD