Shipengine

ShipEngine is a shipping API for comparing carrier rates, buying labels, validating addresses, and tracking shipments.

Type: Tool
Category: Communication
Version: 1.0.0
Provider: InTouch AI
License: MIT

Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

communicationtracker

Shipengine

ShipEngine is a shipping API for comparing carrier rates, buying labels, validating addresses, and tracking shipments.

Base URL: https://api.shipengine.com
Auth: header:API-Key (pass your key via the apiKey input)

Operations

list_batches — GET /v1/batches — List Batches
get_batch_by_external_id — GET /v1/batches/external_batch_id/{external_batch_id} — Get Batch By External ID
get_batch_by_id — GET /v1/batches/{batch_id} — Get Batch By ID
list_batch_errors — GET /v1/batches/{batch_id}/errors — Get Batch Errors
list_carriers — GET /v1/carriers — List Carriers
get_carrier_by_id — GET /v1/carriers/{carrier_id} — Get Carrier By ID

Inputs

apiKey — your shipengine API key
operation — one of the operations above
path parameters when an operation's path contains {...}
query — optional JSON object of query params
body — JSON object for create/update ops

Example

operation: list_batches
apiKey: <your key>

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

error
operation
result
status

Input Properties

Every property this tool accepts, from its own tool.iml.

Property	Type	Required	Default	Description
`apiKey`	string	yes	—	DEPRECATED — bind an API Key credential to the task with `credentialName` instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
`operation`	string	yes	—	One of: list_batches, get_batch_by_external_id, get_batch_by_id, list_batch_errors, list_carriers, get_carrier_by_id
`batch_id`	string	no	—	Path parameter batch_id (required by some operations).
`carrier_id`	string	no	—	Path parameter carrier_id (required by some operations).
`external_batch_id`	string	no	—	Path parameter external_batch_id (required by some operations).
`query`	string	no	—	Optional query params as a JSON object string, e.g. {"limit": 10}.