Skip to main content
Shipengine logo
  • Category: ecommerce
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 66
  • Triggers: 0
  • Slug: SHIPENGINE
  • Version: 20261103_00

Tools

Slug: SHIPENGINE_ADD_TAG_TO_SHIPMENTTool to add a tag to a shipment for organization and filtering. Use when you need to categorize or label a shipment.

Input Parameters

string
required
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.
string
required
Unique ShipEngine shipment ID, must begin with ‘se-’ followed by alphanumeric characters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_ADD_TO_BATCHTool 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

string
required
Unique identifier of the batch to add items to.
array
List of rate IDs to add to the batch. At least one of shipment_ids or rate_ids must be provided.
array
List of shipment IDs to add to the batch. At least one of shipment_ids or rate_ids must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_CANCEL_SHIPMENTTool 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

string
required
Unique ShipEngine shipment ID to cancel, must begin with ‘se-’ followed by alphanumeric characters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_CONNECT_LTL_CARRIERTool 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

object
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.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_CONNECT_SHIPSURANCETool to connect a Shipsurance insurance account to ShipEngine. Use when you need to integrate a Shipsurance policy for insurance coverage on shipments.

Input Parameters

string
required
Email address associated with the Shipsurance account.
string
required
The Shipsurance policy ID to connect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_CREATE_ACCOUNT_IMAGETool to create a new account image in ShipEngine. Use when uploading a logo or image for use on shipping labels.

Input Parameters

string
required
Name of the image (used for identification).
string
required
Base64-encoded image data string. The image should be encoded in base64 format.
string ("image/png" | "image/jpeg")
required
MIME type of the image (e.g., image/png, image/jpeg).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_CREATE_PACKAGE_TYPETool to create a custom package type definition in ShipEngine. Use when defining new package types with specific codes and optional dimensions.

Input Parameters

string
required
Name of the custom package type (required).
object
Dimensions of the package.
string
Description of the package type (optional).
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_CREATE_TAGCreate a new ShipEngine tag for shipments using the supplied name and a fixed red color (#ff0000).

Input Parameters

string
required
The name of the tag to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_CREATE_TAG2Tool 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_CREATE_WAREHOUSETool to create a new warehouse. Use when adding a new inventory location after verifying its full address details.

Input Parameters

boolean
Whether this warehouse should be set as default
object
required
The address where inventory is stored
object
Address object for warehouse origin or return address.
string
required
Name of the warehouse

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_CREATE_WEBHOOKTool 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

string
required
The webhook URL where event notifications will be sent. Must be publicly reachable before registration; unreachable URLs silently drop notifications with no error indication.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_DELETE_ACCOUNT_IMAGE_BY_IDTool 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

string
required
Unique identifier for the label image to delete. Must be a valid image ID from ShipEngine.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_DELETE_BATCHTool 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

string
required
Unique ShipEngine batch ID to delete, must begin with ‘se-’ followed by alphanumeric characters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_DELETE_PACKAGETool to delete a custom package type by ID. Use when removing package types that are no longer needed.

Input Parameters

string
required
Unique package identifier to delete. Must be a valid ShipEngine package ID (e.g., ‘se-28529731’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_DELETE_WAREHOUSETool 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

string
required
Unique identifier for the warehouse to delete. Must be a valid warehouse ID from ShipEngine.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_DELETE_WEBHOOKTool 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

string
required
Unique identifier for the webhook to delete. Must be a valid webhook ID from ShipEngine.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_DISCONNECT_CARRIERTool to disconnect a carrier account from ShipEngine. Use when you need to remove a carrier connection from your ShipEngine account.

Input Parameters

string
required
Unique carrier account identifier in ShipEngine, typically starts with ‘se-’ followed by numeric digits.
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")
required
The carrier name to disconnect, such as stamps_com, ups, fedex, or dhl_express.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_DISCONNECT_SHIPSURANCETool to disconnect a Shipsurance insurance account from ShipEngine. Use when you need to remove the Shipsurance integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_DOWNLOAD_FILETool 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

string
required
Directory identifier in the download path
string
required
Subdirectory identifier in the download path
string
Optional download parameter to control download behavior
string
required
Name of the file to download
integer
Rotation angle for the file in degrees (e.g., 0, 90, 180, 270)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_GET_ACCOUNT_IMAGE_BY_IDTool 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

string
required
Unique label image ID to retrieve the account image settings

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_GET_BATCH_BY_EXTERNAL_IDTool 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

string
required
External batch ID assigned by the client or external system to identify the batch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_GET_BATCH_BY_IDRetrieve detailed information about a batch by ID, including its status, processing errors, and available label download links.

Input Parameters

string
required
Unique ShipEngine batch ID, must begin with ‘se-’ followed by alphanumeric characters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_GET_BATCH_ERRORSTool to retrieve errors that occurred during batch processing. Use when you need to investigate or troubleshoot issues with a specific batch.

Input Parameters

integer
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.
string
required
Unique ShipEngine batch ID to retrieve errors for, must begin with ‘se-’ followed by alphanumeric characters.
integer
Number of results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_GET_BULK_RATESTool 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

array
List of new shipment details to get rates for. Use this OR shipment_ids, not both.
object
required
Rate options including carrier IDs, service codes, and other preferences for fetching rates
array
List of existing ShipEngine shipment IDs to get rates for. Each ID must start with ‘se-’. Use this OR shipments, not both.
string
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.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_GET_INSURANCE_BALANCETool to retrieve the current Shipsurance insurance funds balance. Use when you need to check available insurance balance before purchasing shipment insurance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_GET_LTL_CARRIER_CREDENTIAL_REQUIREMENTSTool 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_GET_LTL_CARRIER_FEATURESTool 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_GET_LTL_CARRIER_OPTIONSTool 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

string
required
The unique identifier (UUID) of the LTL carrier account. Can be obtained by listing LTL carriers or connecting a carrier account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_GET_LTL_CARRIER_PACKAGESTool 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_GET_LTL_CARRIER_SERVICESTool 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

string
required
The unique identifier for the LTL carrier connection. Obtained from listing carriers or connecting a carrier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_GET_PACKAGE_BY_IDTool to get details of a specific custom package type by ID. Use when you need to retrieve package specifications.

Input Parameters

string
required
Unique ShipEngine package ID, must begin with ‘se-’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_GET_SHIPMENT_BY_EXTERNAL_IDTool 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

string
required
External shipment ID assigned by the client or external system to identify the shipment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_GET_SHIPMENT_BY_IDTool to retrieve a shipment by ID. Use when you need detailed shipment information after creation.

Input Parameters

string
required
Unique ShipEngine shipment ID, must begin with ‘se-’ followed by alphanumeric characters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_GET_SHIPMENT_RATESRetrieve shipping rates for an existing ShipEngine shipment to obtain rate quotes. An optional creation-time filter can be supplied in ISO 8601 format.

Input Parameters

string
required
Unique ShipEngine shipment ID, must begin with ‘se-’ followed by alphanumeric characters
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_GET_TRACKING_INFOTool 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

string
required
A shipping carrier, such as ‘fedex’, ‘dhl_express’, ‘stamps_com’, etc.
string
required
The tracking number associated with a shipment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_GET_WAREHOUSE_BY_IDTool to retrieve details of a specific warehouse by ID. Use when you need warehouse information including addresses and default status.

Input Parameters

string
required
Unique ShipEngine warehouse ID, must begin with ‘se-’ followed by alphanumeric characters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_GET_WEBHOOK_BY_IDTool to retrieve details of a specific webhook by ID. Use when you need to view the configuration of an existing webhook.

Input Parameters

string
required
Unique identifier for the webhook to retrieve. Must be a valid ShipEngine webhook ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_LIST_ACCOUNT_IMAGESTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_LIST_ACCOUNT_SETTINGSTool to list all account settings for the ShipEngine account. Use when you need to retrieve account configuration, preferences, or settings information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_LIST_BATCHES2Tool 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

integer
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.
string ("open" | "queued" | "processing" | "completed" | "completed_with_errors" | "archived" | "notifying" | "invalid")
Possible batch status values
string ("ship_date" | "processed_at" | "created_at")
Possible batch sort by values
string
Controls the sort order of the query (asc or desc).
integer
The number of results to return per response.
string
Filter by batch number.
string
Only return batches that were created on or before a specific date/time (ISO 8601 format).
string
Only return batches that were created on or after a specific date/time (ISO 8601 format).
string
Only return batches that were processed on or before a specific date/time (ISO 8601 format).
string
Only return batches that were processed on or after a specific date/time (ISO 8601 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_LIST_CARRIER_PACKAGE_TYPESTool 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

string
required
The unique identifier of the carrier for which to list package types. Must be a valid ShipEngine carrier ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_LIST_LABELS2Tool 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

integer
Return a specific page of results. Defaults to the first page
string
Only return labels associated with a specific rate ID
string ("modified_at" | "created_at" | "voided_at")
Field to sort labels by
string
Only return labels that were created in a specific batch
string ("asc" | "desc")
Sort direction
integer
The number of results to return per response
string
Only return labels for a specific carrier account
string
Only return labels associated with a specific shipment ID
string ("processing" | "completed" | "error" | "voided")
Status of a shipping label
string
Only return labels for a specific carrier service
string
Only return labels that originate from a specific warehouse
string
Only return labels that were created on or before a specific date/time (ISO 8601)
string
Only return labels with a specific tracking number
string
Only return labels that were created on or after a specific date/time (ISO 8601)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_LIST_LTL_CARRIERSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_LIST_MANIFESTS2List manifests with optional filters including warehouse, carrier, dates and label IDs. Results are paginated.

Input Parameters

integer
Page number to return. Defaults to 1. If set to a number greater than available pages, an empty page is returned.
array
Array of label IDs to filter manifests
integer
Number of results to return per page. Defaults to 25.
string
Filter manifests by carrier ID
string
Filter manifests by warehouse ID
string
End of ship date range (ISO 8601 format)
string
Filter for manifests created before this timestamp (ISO 8601 format)
string
Start of ship date range (ISO 8601 format)
string
Filter for manifests created after this timestamp (ISO 8601 format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_LIST_PACKAGESTool to list all package types. Use when selecting package options before shipment creation.

Input Parameters

integer
Page number for pagination (starts at 1).
integer
Number of results per page (max 500).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_LIST_PICKUPSTool to list all scheduled pickups with optional filters. Use when you need to retrieve scheduled pickups with pagination support.

Input Parameters

integer
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.
integer
The number of results to return per response.
string
Filter pickups by carrier ID.
string
Filter pickups by warehouse ID.
string
Only return scheduled pickups that were created on or before a specific date/time (ISO 8601 format).
string
Only return scheduled pickups that were created on or after a specific date/time (ISO 8601 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_LIST_SHIPMENTS2Tool 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

string
Search for shipments based on the custom tag added to the shipment object.
integer
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.
string ("modified_at" | "created_at")
Possible sort by values for shipments.
string
Filter shipments by batch ID.
string
Controls the sort order of the query (asc or desc). Defaults to desc.
integer
The number of results to return per response.
string
Filter shipments created before this timestamp (ISO 8601 format). Used to create a filter for when a resource was created.
string
Filter shipments by sales order ID.
string
Filter shipments modified before this timestamp (ISO 8601 format). Used to create a filter for when a resource was modified.
string ("pending" | "processing" | "label_purchased" | "cancelled")
Possible shipment status values.
string
Filter shipments created after this timestamp (ISO 8601 format). Used to create a filter for when a resource was created.
string
Filter shipments modified after this timestamp (ISO 8601 format). Used to create a filter for when a resource was modified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_LIST_TAGS2Tool to list all tags in your account. Use when you need to retrieve all available tags for display or selection purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_LIST_WAREHOUSESTool to list all warehouses. Use when you need to retrieve warehouse locations with pagination. Call after creating or updating warehouses.

Input Parameters

integer
Page number for pagination (starts at 1).
integer
Number of results per page (max 500).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_LIST_WEBHOOK_EVENTSRetrieve 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_LIST_WEBHOOKSTool to list all webhooks configured on your account. Use when you need to view all registered webhooks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_PARSE_ADDRESSTool 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

string
required
The unstructured text that contains address-related entities
object
Optional partial address with already-known values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_PROCESS_BATCH_LABELSTool 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

string
required
Unique batch ID to process. Must begin with ‘se-’ followed by alphanumeric characters.
string
The ship date the batch is being processed for. Must be in ISO 8601 format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ).
string ("pdf" | "zpl" | "png")
Format of the labels to generate (pdf, zpl, or png).
string ("4x6" | "letter")
Layout size for the labels (4x6 or letter).
string ("label" | "qr_code")
Display format that the label should be shown in (label or qr_code).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_REMOVE_FROM_BATCHTool 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

string
required
Unique identifier for the batch to remove items from.
array
List of rate IDs to remove from the batch. Provide either shipment_ids or rate_ids, or both.
array
List of shipment IDs to remove from the batch. Provide either shipment_ids or rate_ids, or both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_REMOVE_TAG_FROM_SHIPMENTTool 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

string
required
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’).
string
required
Unique ShipEngine shipment ID, must begin with ‘se-’ followed by alphanumeric characters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_START_TRACKINGTool 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

string
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.
string
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.
string
The tracking number associated with the shipment. Required to start tracking the package.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_STOP_TRACKINGTool 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

string
required
A shipping carrier code, such as ‘fedex’, ‘dhl_express’, ‘stamps_com’, ‘ups’, etc. This identifies which carrier is handling the shipment.
string
required
The tracking number associated with the shipment to stop tracking. This is the carrier-provided tracking number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_TRACK_LTL_SHIPMENTTool 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

string
required
The PRO number (tracking number) for the LTL shipment. This is the unique identifier used to track the shipment with the carrier.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_UPDATE_ACCOUNT_IMAGE_BY_IDUpdate an account image by ID in ShipEngine, including its name or image data. The default-image status must be supplied on every update.

Input Parameters

string
Name or description for the image
string
Base64-encoded image data to update the image content
boolean
required
Whether this image should be set as the default account image
string
required
Unique identifier of the label image to update, must begin with ‘img_‘

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_UPDATE_LTL_CONNECTIONTool 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

object
required
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.
string
required
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).
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_UPDATE_PACKAGETool to update an existing custom package type definition. Use when modifying package details such as name, code, description, or dimensions.

Input Parameters

string
required
Updated friendly name for this package type.
object
Dimensions of the package.
string
required
The unique identifier of the package to update (e.g., ‘se-28529731’).
string
Optional description of the package type.
string
required
Updated unique code for this package type. MUST have a ‘custom_’ prefix (e.g., ‘custom_bigbox’, ‘custom_small_box’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_UPDATE_SHIPMENTTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_UPDATE_SHIPMENTS_TAGSTool 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

array
required
Array of shipment and tag associations to update. Each entry specifies a shipment_id and the tags to assign to it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_UPDATE_WAREHOUSEUpdate an existing warehouse’s name, origin address, return address, or default status. The warehouse name and origin address are required for the update.

Input Parameters

string
required
Updated name of the warehouse
boolean
Whether this warehouse should be set as default
string
required
Unique identifier of the warehouse to update (e.g., ‘se-28529731’)
object
required
Updated address where inventory is stored
object
Address object for warehouse origin or return address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_UPDATE_WEBHOOKTool 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

string
The URL that the webhook sends the request to.
string
The name of the webhook.
array
Array of custom webhook headers to send with webhook requests.
integer
Store ID to associate with the webhook.
string
required
Webhook ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPENGINE_VALIDATE_ADDRESSValidate and normalize shipping addresses before shipping. Returns validation statuses and, when available, matched addresses and messages.

Input Parameters

array
required
List of addresses to validate (max 100)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not