# 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.

- **Category:** ecommerce
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 66
- **Triggers:** 0
- **Slug:** `SHIPENGINE`
- **Version:** 20260316_00

## Tools

### Add Tag to Shipment

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_name` | string | Yes | Tag name to add to the shipment. Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. |
| `shipment_id` | string | Yes | Unique ShipEngine shipment ID, must begin with 'se-' followed by alphanumeric characters |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add to Batch

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | string | Yes | Unique identifier of the batch to add items to. |
| `rate_ids` | array | No | List of rate IDs to add to the batch. At least one of shipment_ids or rate_ids must be provided. |
| `shipment_ids` | array | No | List of shipment IDs to add to the batch. At least one of shipment_ids or rate_ids must be provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Shipment

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shipment_id` | string | Yes | Unique ShipEngine shipment ID to cancel, must begin with 'se-' followed by alphanumeric characters |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Connect LTL Carrier

**Slug:** `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 {}.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `credentials` | object | No | Carrier-specific credentials. For TEST/WARN/FAIL sandbox carriers, use empty object {}. For production carriers, use carrier-specific fields (username, password, account_number, etc.) as required by the carrier. |
| `carrier_code` | string | Yes | The carrier code (SCAC) of the LTL carrier to connect. Use TEST, WARN, or FAIL for sandbox testing. For production, use the actual carrier SCAC code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Connect Shipsurance Account

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address associated with the Shipsurance account. |
| `policy_id` | string | Yes | The Shipsurance policy ID to connect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Account Image

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the image (used for identification). |
| `image_data` | string | Yes | Base64-encoded image data string. The image should be encoded in base64 format. |
| `image_content_type` | string ("image/png" | "image/jpeg") | Yes | MIME type of the image (e.g., image/png, image/jpeg). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Package Type

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the custom package type (required). |
| `dimensions` | object | No | Dimensions of the package. |
| `description` | string | No | Description of the package type (optional). |
| `package_code` | string | Yes | Code identifier for the package. MUST have prefix 'custom_' (e.g., 'custom_bigbox', 'custom_test_box'). This is a required format enforced by the ShipEngine API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tag

**Slug:** `SHIPENGINE_CREATE_TAG`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_name` | string | Yes | The name of the tag to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tag 2

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_name` | string | Yes | Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Warehouse

**Slug:** `SHIPENGINE_CREATE_WAREHOUSE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `is_default` | boolean | No | Whether this warehouse should be set as default |
| `origin_address` | object | Yes | The address where inventory is stored |
| `return_address` | object | No | Address object for warehouse origin or return address. |
| `warehouse_name` | string | Yes | Name of the warehouse |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Webhook

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The webhook URL where event notifications will be sent. Must be publicly reachable before registration; unreachable URLs silently drop notifications with no error indication. |
| `event` | string | Yes | The event to subscribe to. Valid events: 'batch', 'track', 'rate', 'carrier_connected', 'report_complete', 'order_source_refresh_complete', 'sales_orders_imported', 'batch_processed_v2', 'fulfillment_rejected_v2', 'fulfillment_shipped_v2'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Account Image by ID

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label_image_id` | string | Yes | Unique identifier for the label image to delete. Must be a valid image ID from ShipEngine. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Batch

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | string | Yes | Unique ShipEngine batch ID to delete, must begin with 'se-' followed by alphanumeric characters |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Package

**Slug:** `SHIPENGINE_DELETE_PACKAGE`

Tool to delete a custom package type by ID. Use when removing package types that are no longer needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `package_id` | string | Yes | Unique package identifier to delete. Must be a valid ShipEngine package ID (e.g., 'se-28529731'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Warehouse

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `warehouse_id` | string | Yes | Unique identifier for the warehouse to delete. Must be a valid warehouse ID from ShipEngine. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Webhook

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Unique identifier for the webhook to delete. Must be a valid webhook ID from ShipEngine. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disconnect Carrier

**Slug:** `SHIPENGINE_DISCONNECT_CARRIER`

Tool to disconnect a carrier account from ShipEngine. Use when you need to remove a carrier connection from your ShipEngine account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `carrier_id` | string | Yes | Unique carrier account identifier in ShipEngine, typically starts with 'se-' followed by numeric digits. |
| `carrier_name` | string ("access_worldwide" | "amazon_buy_shipping" | "amazon_shipping_uk" | "apc" | "asendia" | "australia_post" | "canada_post" | "dhl_ecommerce" | "dhl_express" | "dhl_express_au" | "dhl_express_ca" | "dhl_express_uk" | "dpd" | "endicia" | "fedex" | "fedex_uk" | "firstmile" | "imex" | "newgistics" | "ontrac" | "purolator_canada" | "royal_mail" | "rr_donnelley" | "seko" | "sendle" | "stamps_com" | "ups" | "lasership") | Yes | The carrier name to disconnect, such as stamps_com, ups, fedex, or dhl_express. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disconnect Shipsurance

**Slug:** `SHIPENGINE_DISCONNECT_SHIPSURANCE`

Tool to disconnect a Shipsurance insurance account from ShipEngine. Use when you need to remove the Shipsurance integration.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download File

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dir` | string | Yes | Directory identifier in the download path |
| `subdir` | string | Yes | Subdirectory identifier in the download path |
| `download` | string | No | Optional download parameter to control download behavior |
| `filename` | string | Yes | Name of the file to download |
| `rotation` | integer | No | Rotation angle for the file in degrees (e.g., 0, 90, 180, 270) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Image by ID

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label_image_id` | string | Yes | Unique label image ID to retrieve the account image settings |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Batch by External ID

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `external_batch_id` | string | Yes | External batch ID assigned by the client or external system to identify the batch |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Batch by ID

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | string | Yes | Unique ShipEngine batch ID, must begin with 'se-' followed by alphanumeric characters |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Batch Errors

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Return a specific page of results. Defaults to the first page. If set to a number greater than the number of pages of results, an empty page is returned. |
| `batch_id` | string | Yes | Unique ShipEngine batch ID to retrieve errors for, must begin with 'se-' followed by alphanumeric characters. |
| `pagesize` | integer | No | Number of results to return per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Rates

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shipments` | array | No | List of new shipment details to get rates for. Use this OR shipment_ids, not both. |
| `rate_options` | object | Yes | Rate options including carrier IDs, service codes, and other preferences for fetching rates |
| `shipment_ids` | array | No | List of existing ShipEngine shipment IDs to get rates for. Each ID must start with 'se-'. Use this OR shipments, not both. |
| `ship_to_service_point_id` | string | No | A unique identifier for a carrier service point where the shipment will be delivered by the carrier. This will take precedence over a shipment's ship to address. |
| `ship_from_service_point_id` | string | No | A unique identifier for a carrier drop off point where a merchant plans to deliver packages. This will take precedence over a shipment's ship from address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Insurance Balance

**Slug:** `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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LTL Carrier Credential Requirements

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `carrier_code` | string | Yes | The SCAC (Standard Carrier Alpha Code) for the LTL carrier. Common codes: FXFR (FedEx Freight), FWDN (Forward Air), AACT (AAA Cooper), ABFS (ABF Freight). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LTL Carrier Features

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `carrier_code` | string | Yes | The Standard Carrier Alpha Code (SCAC) identifying the LTL carrier. Examples: 'fxfr' (FedEx Freight), 'fwdn' (Forward Air), 'midw' (Midwest Motor Express), 'aact' (AAA Cooper Transportation). For testing, use: 'TEST' (success), 'WARN' (warnings), 'FAIL' (errors). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LTL Carrier Options

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `carrier_id` | string | Yes | The unique identifier (UUID) of the LTL carrier account. Can be obtained by listing LTL carriers or connecting a carrier account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LTL Carrier Packages

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `carrier_id` | string | Yes | The unique identifier for the LTL carrier. To test in sandbox, connect a TEST carrier using POST /v-beta/ltl/connections/TEST with body {"credentials":{}} |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LTL Carrier Services

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `carrier_id` | string | Yes | The unique identifier for the LTL carrier connection. Obtained from listing carriers or connecting a carrier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Package by ID

**Slug:** `SHIPENGINE_GET_PACKAGE_BY_ID`

Tool to get details of a specific custom package type by ID. Use when you need to retrieve package specifications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `package_id` | string | Yes | Unique ShipEngine package ID, must begin with 'se-' followed by alphanumeric characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Shipment by External ID

**Slug:** `SHIPENGINE_GET_SHIPMENT_BY_EXTERNAL_ID`

Tool to retrieve shipment details using an external shipment ID. Use when you need to look up a shipment by its client-assigned external identifier rather than ShipEngine's internal shipment ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `external_shipment_id` | string | Yes | External shipment ID assigned by the client or external system to identify the shipment |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Shipment by ID

**Slug:** `SHIPENGINE_GET_SHIPMENT_BY_ID`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shipment_id` | string | Yes | Unique ShipEngine shipment ID, must begin with 'se-' followed by alphanumeric characters |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Shipment Rates

**Slug:** `SHIPENGINE_GET_SHIPMENT_RATES`

Tool to retrieve shipping rates for an existing shipment. Use when you need to get rate quotes for a shipment that has already been created.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shipment_id` | string | Yes | Unique ShipEngine shipment ID, must begin with 'se-' followed by alphanumeric characters |
| `created_at_start` | string | No | Used to create a filter for when a resource was created (e.g., a shipment that was created after a certain time). ISO 8601 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tracking Information

**Slug:** `SHIPENGINE_GET_TRACKING_INFO`

Tool to retrieve tracking information for a shipment. Use when you need to track the status and location of a package using its tracking number and carrier code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `carrier_code` | string | Yes | A shipping carrier, such as 'fedex', 'dhl_express', 'stamps_com', etc. |
| `tracking_number` | string | Yes | The tracking number associated with a shipment |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Warehouse by ID

**Slug:** `SHIPENGINE_GET_WAREHOUSE_BY_ID`

Tool to retrieve details of a specific warehouse by ID. Use when you need warehouse information including addresses and default status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `warehouse_id` | string | Yes | Unique ShipEngine warehouse ID, must begin with 'se-' followed by alphanumeric characters |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Webhook by ID

**Slug:** `SHIPENGINE_GET_WEBHOOK_BY_ID`

Tool to retrieve details of a specific webhook by ID. Use when you need to view the configuration of an existing webhook.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Unique identifier for the webhook to retrieve. Must be a valid ShipEngine webhook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Account Images

**Slug:** `SHIPENGINE_LIST_ACCOUNT_IMAGES`

Tool to list all account images. Use when you need to retrieve all images configured for the ShipEngine account, such as logos or branding images used on shipping labels.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Account Settings

**Slug:** `SHIPENGINE_LIST_ACCOUNT_SETTINGS`

Tool to list all account settings for the ShipEngine account. Use when you need to retrieve account configuration, preferences, or settings information.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Batches (v2)

**Slug:** `SHIPENGINE_LIST_BATCHES2`

Tool to list all batches with comprehensive filtering options. Use when you need to retrieve batches with filters for status, creation/processing dates, batch number, or pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Return a specific page of results. Defaults to the first page. If set to a number greater than the number of pages of results, an empty page is returned. |
| `status` | string ("open" | "queued" | "processing" | "completed" | "completed_with_errors" | "archived" | "notifying" | "invalid") | No | Possible batch status values |
| `sort_by` | string ("ship_date" | "processed_at" | "created_at") | No | Possible batch sort by values |
| `sort_dir` | string | No | Controls the sort order of the query (asc or desc). |
| `page_size` | integer | No | The number of results to return per response. |
| `batch_number` | string | No | Filter by batch number. |
| `created_at_end` | string | No | Only return batches that were created on or before a specific date/time (ISO 8601 format). |
| `created_at_start` | string | No | Only return batches that were created on or after a specific date/time (ISO 8601 format). |
| `processed_at_end` | string | No | Only return batches that were processed on or before a specific date/time (ISO 8601 format). |
| `processed_at_start` | string | No | Only return batches that were processed on or after a specific date/time (ISO 8601 format). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Carrier Package Types

**Slug:** `SHIPENGINE_LIST_CARRIER_PACKAGE_TYPES`

Tool to list all available package types for a specific carrier. Use when you need to find valid package_code values before creating shipments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `carrier_id` | string | Yes | The unique identifier of the carrier for which to list package types. Must be a valid ShipEngine carrier ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Labels (Extended)

**Slug:** `SHIPENGINE_LIST_LABELS2`

Tool to list all shipping labels with comprehensive filtering options. Use when you need to retrieve labels with filters like status, carrier, tracking number, batch, or date ranges. Supports sorting and pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Return a specific page of results. Defaults to the first page |
| `rate_id` | string | No | Only return labels associated with a specific rate ID |
| `sort_by` | string ("modified_at" | "created_at" | "voided_at") | No | Field to sort labels by |
| `batch_id` | string | No | Only return labels that were created in a specific batch |
| `sort_dir` | string ("asc" | "desc") | No | Sort direction |
| `page_size` | integer | No | The number of results to return per response |
| `carrier_id` | string | No | Only return labels for a specific carrier account |
| `shipment_id` | string | No | Only return labels associated with a specific shipment ID |
| `label_status` | string ("processing" | "completed" | "error" | "voided") | No | Status of a shipping label |
| `service_code` | string | No | Only return labels for a specific carrier service |
| `warehouse_id` | string | No | Only return labels that originate from a specific warehouse |
| `created_at_end` | string | No | Only return labels that were created on or before a specific date/time (ISO 8601) |
| `tracking_number` | string | No | Only return labels with a specific tracking number |
| `created_at_start` | string | No | Only return labels that were created on or after a specific date/time (ISO 8601) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List LTL Carriers

**Slug:** `SHIPENGINE_LIST_LTL_CARRIERS`

Tool to list all LTL (Less-Than-Truckload) carrier accounts connected to your ShipEngine account. Use when you need to discover available LTL carriers, their services, container types, and accessorial services before creating LTL shipments.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Manifests (Advanced)

**Slug:** `SHIPENGINE_LIST_MANIFESTS2`

Tool to list all manifests with optional filtering by warehouse and carrier. Use when you need to retrieve manifests with advanced filtering options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to return. Defaults to 1. If set to a number greater than available pages, an empty page is returned. |
| `label_ids` | array | No | Array of label IDs to filter manifests |
| `page_size` | integer | No | Number of results to return per page. Defaults to 25. |
| `carrier_id` | string | No | Filter manifests by carrier ID |
| `warehouse_id` | string | No | Filter manifests by warehouse ID |
| `ship_date_end` | string | No | End of ship date range (ISO 8601 format) |
| `created_at_end` | string | No | Filter for manifests created before this timestamp (ISO 8601 format) |
| `ship_date_start` | string | No | Start of ship date range (ISO 8601 format) |
| `created_at_start` | string | No | Filter for manifests created after this timestamp (ISO 8601 format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Packages

**Slug:** `SHIPENGINE_LIST_PACKAGES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (starts at 1). |
| `page_size` | integer | No | Number of results per page (max 500). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Scheduled Pickups

**Slug:** `SHIPENGINE_LIST_PICKUPS`

Tool to list all scheduled pickups with optional filters. Use when you need to retrieve scheduled pickups with pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Return a specific page of results. Defaults to the first page. If set to a number greater than the number of pages of results, an empty page is returned. |
| `page_size` | integer | No | The number of results to return per response. |
| `carrier_id` | string | No | Filter pickups by carrier ID. |
| `warehouse_id` | string | No | Filter pickups by warehouse ID. |
| `created_at_end` | string | No | Only return scheduled pickups that were created on or before a specific date/time (ISO 8601 format). |
| `created_at_start` | string | No | Only return scheduled pickups that were created on or after a specific date/time (ISO 8601 format). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Shipments (v2)

**Slug:** `SHIPENGINE_LIST_SHIPMENTS2`

Tool to list all shipments with optional filtering parameters. Use when you need to retrieve shipments with filters like status, batch, tags, or date ranges.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | No | Search for shipments based on the custom tag added to the shipment object. |
| `page` | integer | No | Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned. |
| `sort_by` | string ("modified_at" | "created_at") | No | Possible sort by values for shipments. |
| `batch_id` | string | No | Filter shipments by batch ID. |
| `sort_dir` | string | No | Controls the sort order of the query (asc or desc). Defaults to desc. |
| `page_size` | integer | No | The number of results to return per response. |
| `created_at_end` | string | No | Filter shipments created before this timestamp (ISO 8601 format). Used to create a filter for when a resource was created. |
| `sales_order_id` | string | No | Filter shipments by sales order ID. |
| `modified_at_end` | string | No | Filter shipments modified before this timestamp (ISO 8601 format). Used to create a filter for when a resource was modified. |
| `shipment_status` | string ("pending" | "processing" | "label_purchased" | "cancelled") | No | Possible shipment status values. |
| `created_at_start` | string | No | Filter shipments created after this timestamp (ISO 8601 format). Used to create a filter for when a resource was created. |
| `modified_at_start` | string | No | Filter shipments modified after this timestamp (ISO 8601 format). Used to create a filter for when a resource was modified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tags (v2)

**Slug:** `SHIPENGINE_LIST_TAGS2`

Tool to list all tags in your account. Use when you need to retrieve all available tags for display or selection purposes.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Warehouses

**Slug:** `SHIPENGINE_LIST_WAREHOUSES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (starts at 1). |
| `page_size` | integer | No | Number of results per page (max 500). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhook Events

**Slug:** `SHIPENGINE_LIST_WEBHOOK_EVENTS`

Retrieve a list of available webhook event types supported by ShipEngine. Returns static documentation of all supported webhook events that can be used when creating webhooks. Always call this before SHIPENGINE_CREATE_WEBHOOK to obtain valid event type names — unsupported or mistyped event names result in no callbacks being received. Note: This is based on ShipEngine's documented event types as there is no API endpoint for listing events.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhooks

**Slug:** `SHIPENGINE_LIST_WEBHOOKS`

Tool to list all webhooks configured on your account. Use when you need to view all registered webhooks.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Parse Address

**Slug:** `SHIPENGINE_PARSE_ADDRESS`

Tool to parse unstructured address text and extract structured address components. Use when you have raw address text and need to extract individual fields like street, city, state, and postal code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | The unstructured text that contains address-related entities |
| `address` | object | No | Optional partial address with already-known values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Process Batch Labels

**Slug:** `SHIPENGINE_PROCESS_BATCH_LABELS`

Tool to process a batch to create and purchase shipping labels for all shipments in the batch. Use after creating a batch with shipments. The API returns HTTP 204 on success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | string | Yes | Unique batch ID to process. Must begin with 'se-' followed by alphanumeric characters. |
| `ship_date` | string | No | The ship date the batch is being processed for. Must be in ISO 8601 format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ). |
| `label_format` | string ("pdf" | "zpl" | "png") | No | Format of the labels to generate (pdf, zpl, or png). |
| `label_layout` | string ("4x6" | "letter") | No | Layout size for the labels (4x6 or letter). |
| `display_scheme` | string ("label" | "qr_code") | No | Display format that the label should be shown in (label or qr_code). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove From Batch

**Slug:** `SHIPENGINE_REMOVE_FROM_BATCH`

Tool to remove shipments or rate IDs from a batch. Use when you need to modify batch contents by removing specific shipments or rates. At least one of shipment_ids or rate_ids must be provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | string | Yes | Unique identifier for the batch to remove items from. |
| `rate_ids` | array | No | List of rate IDs to remove from the batch. Provide either shipment_ids or rate_ids, or both. |
| `shipment_ids` | array | No | List of shipment IDs to remove from the batch. Provide either shipment_ids or rate_ids, or both. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Tag from Shipment

**Slug:** `SHIPENGINE_REMOVE_TAG_FROM_SHIPMENT`

Tool to remove a tag from a shipment. Use when you need to un-categorize or remove a specific tag from an existing shipment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_name` | string | Yes | The name of the tag to remove from the shipment. Tags are arbitrary strings that you can use to categorize shipments (e.g., 'Fragile', 'Priority', 'International'). |
| `shipment_id` | string | Yes | Unique ShipEngine shipment ID, must begin with 'se-' followed by alphanumeric characters |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Tracking Package

**Slug:** `SHIPENGINE_START_TRACKING`

Tool to subscribe to tracking updates for a package via webhooks. Use when you need to start monitoring a shipment's status. The package tracking information will be sent to configured webhooks when updates occur.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `carrier_id` | string | No | ShipEngine carrier ID (alternative to carrier_code). Must begin with 'se-' followed by alphanumeric characters. Provide either carrier_code or carrier_id to identify the carrier. |
| `carrier_code` | string | No | A shipping carrier code, such as 'fedex', 'dhl_express', 'stamps_com', 'ups', 'usps', etc. Provide either carrier_code or carrier_id to identify the carrier. |
| `tracking_number` | string | No | The tracking number associated with the shipment. Required to start tracking the package. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Stop Tracking Package

**Slug:** `SHIPENGINE_STOP_TRACKING`

Tool to unsubscribe from tracking updates for a package. Use when you no longer need to receive tracking notifications for a specific shipment. Once stopped, you will not receive further tracking updates for this package.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `carrier_code` | string | Yes | A shipping carrier code, such as 'fedex', 'dhl_express', 'stamps_com', 'ups', etc. This identifies which carrier is handling the shipment. |
| `tracking_number` | string | Yes | The tracking number associated with the shipment to stop tracking. This is the carrier-provided tracking number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Track LTL Shipment

**Slug:** `SHIPENGINE_TRACK_LTL_SHIPMENT`

Tool to track an LTL shipment using carrier code and PRO number. Use when you need to retrieve real-time tracking information for an LTL shipment, including current status, delivery dates, and event history.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pro_number` | string | Yes | The PRO number (tracking number) for the LTL shipment. This is the unique identifier used to track the shipment with the carrier. |
| `carrier_code` | string | Yes | The Standard Carrier Alpha Code (SCAC) for your LTL carrier. Examples: 'fxfr' (FedEx Freight), 'fwdn' (Forward Air), 'midw' (Midwest Motor Express). For testing, use: 'TEST' (success). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Account Image By ID

**Slug:** `SHIPENGINE_UPDATE_ACCOUNT_IMAGE_BY_ID`

Tool to update an account image by ID in ShipEngine. Use when modifying image properties like name or default status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name or description for the image |
| `image_data` | string | No | Base64-encoded image data to update the image content |
| `is_default` | boolean | Yes | Whether this image should be set as the default account image |
| `label_image_id` | string | Yes | Unique identifier of the label image to update, must begin with 'img_' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update LTL Connection

**Slug:** `SHIPENGINE_UPDATE_LTL_CONNECTION`

Tool to update LTL carrier connection credentials in ShipEngine. Use when you need to modify authentication credentials for an existing LTL carrier connection without disconnecting and reconnecting. You must provide all credential properties for the carrier, not just the property you wish to update.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `credentials` | object | Yes | Credentials object with fields specific to each carrier (e.g., username, password, account_number, key, secret, securitycode). You MUST provide all credential properties for the carrier, not just the one you wish to update. Each LTL carrier has different authentication requirements - use Get Credential Requirements endpoint to discover required fields. |
| `carrier_code` | string | Yes | The SCAC (Standard Carrier Alpha Code) for the LTL carrier (e.g., 'FXFR' for FedEx Freight, 'FWDN' for Forward Air, 'PYLE' for A. Duie Pyle, 'TEST' for testing). |
| `connection_id` | string | Yes | The unique carrier_id representing the connection with a specific carrier. This UUID is returned when connecting a carrier and can be retrieved from the List Connected Carriers endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Package Type

**Slug:** `SHIPENGINE_UPDATE_PACKAGE`

Tool to update an existing custom package type definition. Use when modifying package details such as name, code, description, or dimensions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Updated friendly name for this package type. |
| `dimensions` | object | No | Dimensions of the package. |
| `package_id` | string | Yes | The unique identifier of the package to update (e.g., 'se-28529731'). |
| `description` | string | No | Optional description of the package type. |
| `package_code` | string | Yes | Updated unique code for this package type. MUST have a 'custom_' prefix (e.g., 'custom_bigbox', 'custom_small_box'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Shipment

**Slug:** `SHIPENGINE_UPDATE_SHIPMENT`

Tool to update an existing shipment's details. Use when you need to modify shipment information such as addresses, packages, weight, or carrier options before creating a label.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Custom tags for organizing and filtering shipments |
| `items` | array | No | List of items in the shipment (for inventory tracking) |
| `customs` | object | No | Customs information for international shipments. |
| `ship_to` | object | Yes | Updated destination address for the shipment |
| `packages` | array | No | List of packages in the shipment with weight, dimensions, and insurance details |
| `is_return` | boolean | No | Indicates whether this is a return shipment |
| `return_to` | object | No | Address model for ship_to, ship_from, and return_to. |
| `ship_date` | string | No | Planned ship date in ISO 8601 format (YYYY-MM-DD) |
| `ship_from` | object | Yes | Updated origin address for the shipment |
| `carrier_id` | string | No | Carrier ID to use for shipping (e.g., 'se-123456') |
| `shipment_id` | string | Yes | Unique ShipEngine shipment ID to update, must begin with 'se-' followed by alphanumeric characters |
| `confirmation` | string | No | Delivery confirmation type (e.g., 'none', 'delivery', 'signature', 'adult_signature') |
| `service_code` | string | No | Service level code (e.g., 'usps_priority_mail', 'fedex_ground') |
| `warehouse_id` | string | No | Warehouse ID to ship from (if using warehouse management) |
| `tax_identifiers` | array | No | Tax identification numbers for international shipments |
| `advanced_options` | object | No | Advanced shipping options (carrier-specific features). |
| `validate_address` | string | No | Address validation option ('no_validation', 'validate_only', 'validate_and_clean') |
| `external_order_id` | string | No | Your external order reference ID |
| `insurance_provider` | string | No | Insurance provider (e.g., 'shipsurance', 'carrier', 'none') |
| `external_shipment_id` | string | No | Your external shipment reference ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Shipments Tags

**Slug:** `SHIPENGINE_UPDATE_SHIPMENTS_TAGS`

Tool to update tags on one or more shipments in bulk. Use when you need to assign existing tags to shipments. Tags must be created before assignment using the Create Tag action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shipments_tags` | array | Yes | Array of shipment and tag associations to update. Each entry specifies a shipment_id and the tags to assign to it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Warehouse

**Slug:** `SHIPENGINE_UPDATE_WAREHOUSE`

Tool to update an existing warehouse's details and address. Use when modifying warehouse information such as name, origin address, return address, or default status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Updated name of the warehouse |
| `is_default` | boolean | No | Whether this warehouse should be set as default |
| `warehouse_id` | string | Yes | Unique identifier of the warehouse to update (e.g., 'se-28529731') |
| `origin_address` | object | Yes | Updated address where inventory is stored |
| `return_address` | object | No | Address object for warehouse origin or return address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Webhook

**Slug:** `SHIPENGINE_UPDATE_WEBHOOK`

Tool to update a ShipEngine webhook. Use when you need to modify webhook URL, name, headers, or store association. Returns success on 204 status code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | The URL that the webhook sends the request to. |
| `name` | string | No | The name of the webhook. |
| `headers` | array | No | Array of custom webhook headers to send with webhook requests. |
| `store_id` | integer | No | Store ID to associate with the webhook. |
| `webhook_id` | string | Yes | Webhook ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate Address

**Slug:** `SHIPENGINE_VALIDATE_ADDRESS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `addresses` | array | Yes | List of addresses to validate (max 100) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |