Shipengine | Composio Docs

Overview

SLUG: SHIPENGINE

Description

ShipEngine is a REST API that simplifies shipping processes by integrating with multiple carriers, allowing users to manage shipping labels, track packages, and validate addresses efficiently.

Authentication Details

API Key

generic_api_key

stringRequired

Connecting to Shipengine

Create an auth config

Use the dashboard to create an auth config for the Shipengine toolkit. This allows you to connect multiple Shipengine accounts to Composio for agents to use.

Select App

Navigate to Shipengine.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Shipengine Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 shipengine_auth_config_id = "ac_YOUR_SHIPENGINE_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Shipengine for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, shipengine_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Shipengine toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

SHIPENGINE_CREATE_PACKAGE

Tool Name: Create Package Type

Description

Tool to create a new custom package type. Use after defining package dimensions and weight.

Action Parameters

dimensions

objectRequired

name

package_code

stringRequired

weight

objectRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SHIPENGINE_CREATE_TAG

Tool Name: Create Tag

Description

Tool to create a new tag in ShipEngine. Use after determining the desired tag name for shipments.

Action Parameters

tag_name

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SHIPENGINE_CREATE_WAREHOUSE

Tool Name: Create Warehouse

Description

Tool to create a new warehouse. Use when adding a new inventory location after verifying its full address details.

Action Parameters

is_default

origin_address

objectRequired

return_address

warehouse_name

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SHIPENGINE_CREATE_WEBHOOK

Tool Name: Create Webhook

Description

Tool to create a ShipEngine webhook. Use when you need to register a webhook for specific events. Use after confirming your event-handling endpoint is ready.

Action Parameters

enabled

booleanDefaults to True

event

stringRequired

url

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SHIPENGINE_GET_SHIPMENT_BY_ID

Tool Name: Get Shipment by ID

Description

Tool to retrieve a shipment by ID. Use when you need detailed shipment information after creation.

Action Parameters

shipment_id

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SHIPENGINE_LIST_BATCHES

Tool Name: List Batches

Description

Tool to list all batches. Use when you need to retrieve batches with optional filters, sorting, or pagination. Call after creating or updating batches.

Action Parameters

batch_status

page

Defaults to 1

page_size

sort_by

sort_dir

Action Response

data

objectRequired

error

successful

booleanRequired

SHIPENGINE_LIST_LABELS

Tool Name: List Labels

Description

Tool to list all shipping labels. Use when you need to retrieve labels with optional filters and pagination. Call after label creation or to monitor shipments.

Action Parameters

carrier_id

created_at_end

created_at_start

label_status

page

Defaults to 1

page_size

Defaults to 50

service_code

ship_date_end

ship_date_start

tracking_number

warehouse_id

Action Response

data

objectRequired

error

successful

booleanRequired

SHIPENGINE_LIST_MANIFESTS

Tool Name: List Manifests

Description

Tool to list all manifests. Use when you need to retrieve a paginated list of manifests with optional filters.

Action Parameters

created_at_end

created_at_start

page

Defaults to 1

page_size

status

voided

Action Response

data

objectRequired

error

successful

booleanRequired

SHIPENGINE_LIST_PACKAGES

Tool Name: List Packages

Description

Tool to list all package types. Use when selecting package options before shipment creation.

Action Parameters

page

Defaults to 1

page_size

Action Response

data

objectRequired

error

successful

booleanRequired

SHIPENGINE_LIST_SHIPMENTS

Tool Name: List Shipments

Description

Tool to list shipments with optional filters. Use after creating shipments to retrieve or monitor shipments.

Action Parameters

carrier_id

created_at_end

created_at_start

modified_at_end

modified_at_start

page

Defaults to 1

page_size

Defaults to 50

recipient_name

sales_order_id

service_code

ship_date_end

ship_date_start

sort_by

sort_dir

Action Response

data

objectRequired

error

successful

booleanRequired

SHIPENGINE_LIST_TAGS

Tool Name: List Tags

Description

Tool to list all tags. Use when you need to retrieve all tags associated with your account.

Action Parameters

Action Response

data

objectRequired

error

successful

booleanRequired

SHIPENGINE_LIST_WAREHOUSES

Tool Name: List Warehouses

Description

Tool to list all warehouses. Use when you need to retrieve warehouse locations with pagination. Call after creating or updating warehouses.

Action Parameters

page

Defaults to 1

page_size

Defaults to 25

Action Response

data

objectRequired

error

successful

booleanRequired

SHIPENGINE_LIST_WEBHOOK_EVENTS

Tool Name: List Webhook Events

Description

Retrieve a list of available webhook event types.

Action Parameters

Action Response

data

objectRequired

error

successful

booleanRequired

SHIPENGINE_VALIDATE_ADDRESS

Tool Name: Validate Address

Description

Tool to validate and normalize shipping addresses. Use after collecting raw addresses to ensure they are correct and standardized before shipping.

Action Parameters

addresses

arrayRequired

Action Response

data

objectRequired

error

successful

booleanRequired