When you configure an export, import, or other type of flow step using the prebuilt ShipEngine connector, you can select any of the API operations listed below*, organized by API type.
Note
If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the ShipEngine API documentation. *You can also create a composite endpoint for this application in HTTP mode.
|
Resource |
API endpoint |
Export |
Import |
|---|---|---|---|
|
Address |
Validate an address |
X |
|
|
Batches |
List batches |
X |
|
|
Get batch by ID |
X |
||
|
Get batch by external ID |
X |
||
|
Get batch errors |
X |
||
|
Create a batch |
X |
||
|
Update batch by ID |
X |
||
|
Delete batch by ID |
X |
||
|
Add to a batch |
X |
||
|
Remove from batch |
X |
||
|
Process batch ID labels |
X |
||
|
Carriers |
List carriers |
X |
|
|
Get carrier by ID |
X |
||
|
Get carrier options |
X |
||
|
List carrier package types |
X |
||
|
List carrier services |
X |
||
|
Add funds to carrier |
X |
||
|
Labels |
List labels |
X |
|
|
Get label by ID |
X |
||
|
Get label by external shipment ID |
X |
||
|
Get label tracking information |
X |
||
|
Create a return label |
X |
||
|
Purchase label |
X |
||
|
Purchase label with rate ID |
X |
||
|
Purchase label with shipment ID |
X |
||
|
Void a label by ID |
X |
||
|
Manifests |
List manifests |
X |
|
|
Get manifest by ID |
X |
||
|
Create manifest |
X |
||
|
Package types |
List custom package types |
X |
|
|
Get custom package type by ID |
X |
||
|
Create custom package type |
X |
||
|
Update custom package type by ID |
X |
||
|
Delete a custom package type by ID |
X |
||
|
Rates |
Get rate by ID |
X |
|
|
Get shipping rates |
X |
||
|
Shipments |
List shipments |
X |
|
|
Get shipment by ID |
X |
||
|
Get shipment by external ID |
X |
||
|
Get shipment rates |
X |
||
|
Create shipments |
X |
||
|
Update shipment by ID |
X |
||
|
Cancel a shipment |
X |
||
|
Add tag to shipment |
X |
||
|
Remove tag from shipment |
X |
||
|
Tags |
Get tags |
X |
|
|
Create a new tag |
X |
||
|
Update tag name |
X |
||
|
Delete tag |
X |
||
|
Tracking |
Get tracking information |
X |
|
|
Start tracking a package |
X |
||
|
Stop tracking a package |
X |
||
|
Warehouses |
List warehouses |
X |
|
|
Get warehouse by ID |
X |
||
|
Create warehouse |
X |
||
|
Update warehouse by ID |
X |
||
|
Delete warehouse by ID |
X |
||
|
Webhooks |
List webhooks |
X |
|
|
Get webhook by ID |
X |
||
|
Create a webhook |
X |
||
|
Update a webhook |
X |
||
|
Delete webhook by ID |
X |
Comments
Please sign in to leave a comment.