API_KEY
shipengine_api_key
Developer setup
No fields declared in this snapshot.
User connection
- ShipEngine API Keygeneric_api_key · stringRequired
SHIPENGINE
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.
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
66
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
API_KEY
No fields declared in this snapshot.
Capability index
Showing 1–30 of 66 actions
SHIPENGINE_ADD_TAG_TO_SHIPMENT
Tool to add a tag to a shipment for organization and filtering. Use when you need to categorize or label a shipment.
Untrusted display-only summary
SHIPENGINE_ADD_TO_BATCH
Tool to add shipments or rate IDs to an existing batch. Use when you need to add items to a batch after the batch has been created. At least one of shipment_ids or rate_ids must be provided.
Untrusted display-only summary
SHIPENGINE_CANCEL_SHIPMENT
Tool to cancel a shipment by ID. Use when you need to cancel a shipment that has been created but not yet shipped. Note that once a shipment is in transit, it may not be cancellable depending on carrier policies.
Untrusted display-only summary
SHIPENGINE_CONNECT_LTL_CARRIER
Tool to connect an LTL carrier account to ShipEngine. Use when you need to add an LTL carrier connection for freight shipping. For sandbox testing, use carrier codes TEST, WARN, or FAIL with empty credentials {}.
Untrusted display-only summary
SHIPENGINE_CONNECT_SHIPSURANCE
Tool to connect a Shipsurance insurance account to ShipEngine. Use when you need to integrate a Shipsurance policy for insurance coverage on shipments.
Untrusted display-only summary
SHIPENGINE_CREATE_ACCOUNT_IMAGE
Tool to create a new account image in ShipEngine. Use when uploading a logo or image for use on shipping labels.
Untrusted display-only summary
SHIPENGINE_CREATE_PACKAGE_TYPE
Tool to create a custom package type definition in ShipEngine. Use when defining new package types with specific codes and optional dimensions.
Untrusted display-only summary
SHIPENGINE_CREATE_TAG
Tool to create a new tag in ShipEngine. Use after determining the desired tag name for shipments.
Untrusted display-only summary
SHIPENGINE_CREATE_TAG2
Tool to create a new tag for organizing shipments. Use when you need to create a tag by specifying the tag name in the URL path.
Untrusted display-only summary
SHIPENGINE_CREATE_WAREHOUSE
Tool to create a new warehouse. Use when adding a new inventory location after verifying its full address details.
Untrusted display-only summary
SHIPENGINE_CREATE_WEBHOOK
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.
Untrusted display-only summary
SHIPENGINE_DELETE_ACCOUNT_IMAGE_BY_ID
Tool to delete a ShipEngine account image by its ID. Use when you need to remove an image from account settings. The image will be permanently removed from the account.
Untrusted display-only summary
SHIPENGINE_DELETE_BATCH
Tool to delete a batch by ID. Use when you need to remove a batch from ShipEngine. Note that this operation is destructive and cannot be undone.
Untrusted display-only summary
SHIPENGINE_DELETE_PACKAGE
Tool to delete a custom package type by ID. Use when removing package types that are no longer needed.
Untrusted display-only summary
SHIPENGINE_DELETE_WAREHOUSE
Tool to delete a warehouse from your ShipEngine account. Use when you need to remove a warehouse that is no longer needed. The warehouse will be permanently removed from your account.
Untrusted display-only summary
SHIPENGINE_DELETE_WEBHOOK
Tool to delete a ShipEngine webhook subscription. Use when you need to remove a webhook that is no longer needed. The webhook will be permanently removed and will no longer receive event notifications.
Untrusted display-only summary
SHIPENGINE_DISCONNECT_CARRIER
Tool to disconnect a carrier account from ShipEngine. Use when you need to remove a carrier connection from your ShipEngine account.
Untrusted display-only summary
SHIPENGINE_DISCONNECT_SHIPSURANCE
Tool to disconnect a Shipsurance insurance account from ShipEngine. Use when you need to remove the Shipsurance integration.
Untrusted display-only summary
SHIPENGINE_DOWNLOAD_FILE
Tool to download a file from ShipEngine. Use when you need to retrieve a label PDF or other document from the ShipEngine downloads endpoint.
Untrusted display-only summary
SHIPENGINE_GET_ACCOUNT_IMAGE_BY_ID
Tool to retrieve account image settings by label image ID. Use when you need to fetch image data for labels or display account branding information.
Untrusted display-only summary
SHIPENGINE_GET_BATCH_BY_EXTERNAL_ID
Tool to retrieve batch details using an external batch ID. Use when you need to look up a batch by its client-assigned external identifier rather than ShipEngine's internal batch ID.
Untrusted display-only summary
SHIPENGINE_GET_BATCH_BY_ID
Tool to retrieve detailed information about a specific batch by its ID. Use when you need to check batch status, download labels, or view errors.
Untrusted display-only summary
SHIPENGINE_GET_BATCH_ERRORS
Tool to retrieve errors that occurred during batch processing. Use when you need to investigate or troubleshoot issues with a specific batch.
Untrusted display-only summary
SHIPENGINE_GET_BULK_RATES
Tool to get shipping rates for multiple shipments in a single request. Use when you need to compare rates across multiple carriers or shipments efficiently. The request is processed asynchronously - use the returned rate_request_id to retrieve the actual rates once processing is complete.
Untrusted display-only summary
SHIPENGINE_GET_INSURANCE_BALANCE
Tool to retrieve the current Shipsurance insurance funds balance. Use when you need to check available insurance balance before purchasing shipment insurance.
Untrusted display-only summary
SHIPENGINE_GET_LTL_CARRIER_CREDENTIAL_REQUIREMENTS
Tool to retrieve credential requirements for connecting an LTL carrier. Use when you need to discover what credentials (e.g., account number, username, password) are required before connecting a specific LTL carrier.
Untrusted display-only summary
SHIPENGINE_GET_LTL_CARRIER_FEATURES
Tool to retrieve features supported by an LTL carrier. Use when you need to discover what capabilities (e.g., tracking, quotes, scheduled pickups) are available for a specific LTL carrier before creating shipments.
Untrusted display-only summary
SHIPENGINE_GET_LTL_CARRIER_OPTIONS
Tool to list available options/accessorials for an LTL carrier. Use when you need to discover what accessorial services (e.g., hazardous material, inside pickup, lift gate) are available for a specific LTL carrier connection.
Untrusted display-only summary
SHIPENGINE_GET_LTL_CARRIER_PACKAGES
Tool to list available package/handling unit types for an LTL (Less Than Truckload) carrier. Use when you need to find valid package codes for LTL freight shipments.
Untrusted display-only summary
SHIPENGINE_GET_LTL_CARRIER_SERVICES
Tool to list available services for an LTL carrier. Use when you need to discover what shipping services (e.g., standard, guaranteed morning/noon) are available for a specific LTL carrier connection.
Untrusted display-only summary
Provenance
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.