Automation: Platform and API users
Learn how to best use Automation based on how you use ShippyPro
Automations in ShippyPro allow you to automate actions based on specific events in your shipping workflow. However, not all users can leverage automations in the same way: it depends on how you use ShippyPro.
This guide outlines the 3 types of users and the automation triggers available to each, so you can apply the right approach and set expectations accurately.
Summary
|
User type |
Pre-shipment use cases |
Post-shipment use cases |
Notes |
|
Platform |
✅ Yes |
✅ Yes |
Full automation potential |
|
Hybrid (putorder api) |
✅ Yes |
✅ Yes |
Full automation potential |
|
API (ship api) |
No |
✅ Yes |
Only reactive automation of errors fixing available; Async label handling |
Platform Users
How you use ShippyPro: Orders are imported via marketplace/store integrations or CSV upload, and shipping is done via the platform.
Available Triggers:
- Order is imported: Triggered when a new order is imported. Enables pre-shipping automations:
- Format actions to prevent errors at the label generation
-
- Add parcels or order notes
-
- Auto-generate shipping labels
-
- More use cases here
- More use cases here
- Order in error: Triggered when label creation fails due to different causes. This trigger is useful for workflows aimed to automatically resolve the error once it is received.
Recommendation:
Leverage both triggers to fully automate your pre-shipment and error-management processes.
Hybrid Users (API + Platform)
How you use ShippyPro: Orders are imported via PUTORDER API, and then the platform is used for shipping.
Available Triggers:
Same use cases as platform users: once the order is imported via API, your flows are the same.
Recommendation:
Use automation just like a Platform User. Automations are fully available — only the import method differs.
API Users (SHIP API)
How you use ShippyPro: Orders are not imported. Instead, you generate the label directly via SHIP API.
Not Available:
- Order is imported: Not triggered, as no order is “imported” into the system.
Available Trigger:
- Order in error: Triggered when label generation fails via SHIP API.
Workflow Use Case:
Currently, you can only use automation to automate the error fixing (e.g., auto-retry, auto-fix), not to prevent the errors via formatting actions.
Label Recovery Options:
Once automation successfully generates a label, you have 3 ways to retrieve it:
- Platform: The label is available in the “Shipped” tab, ready to print.
- GetLabelUrl API: Use GetLabelUrl to retrieve the label.
⚠️ Important: Workflows are asynchronous and may take from <1s to 30s+. Introduce a delay before calling this endpoint. - Order Shipped Webhook: Use this webhook to get notified and fetch the label programmatically.
Recommendation:
Proactive automations (e.g., auto-format address) are not possible at the moment for your flow.
Focus on error recovery workflows and make sure to implement label recovery logic using either a delay (buffer time) or the Order Shipped Webhook.