Shipengine Tools

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.

Write ActionRisk level 2 of 5API key connectionFree Action

Use Shipengine Get Batch By External Id

Owner App

Shipengine ToolsApp

Required inputs

external_batch_idRequiredstring

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

Observable output

dataRequired
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulRequiredboolean
Whether or not the action execution was successful or not

Setup and approval

API key connection. Risk level 2 of 5.

Pricing and limits

Free Action

Unified payment: Not currently supported

Skills that use this Action

No published Skills explicitly reference this Action yet.

Official source

Provider source