API access for shipment tracking is available on specific AfterShip Tracking plans. Below is a detailed breakdown of the eligibility criteria and alternatives for users on lower-tier plans.
API Access Eligibility by Plan
Essentials Plan: API access is not included in the Essentials plan. Users on this plan cannot create API keys or use the Tracking API.
Premium Plan and Higher: API access begins with Premium and higher-tier plans. This includes the ability to create API keys and use the Tracking API for shipment tracking, offering additional features and higher shipment quotas.
Trial Period Access: During trial periods, API access is temporarily available. If you had access to the API during your trial but lost it after subscribing to the Essentials plan, this is because the Essentials plan does not include API access. Upgrading to a Premium or higher plan will restore API functionality.
Alternatives for Essentials Plan Users
If you are on the Essentials plan and cannot access the API, consider these alternatives:
CSV Import: Upload shipment data via CSV files.
App import: Use supported third-party apps (eCommerce) to auto-import, track, and manage shipments.
Manual entry: Add shipments manually through the dashboard.
FAQs
1. Why can’t I access the API even though I think I’m on a Premium plan?
Ensure that you are subscribed to an eligible AfterShip Tracking Premium plan. If you are on a Shipping plan (e.g., AfterShip Shipping Pro) or a Tracking Essentials plan, API access will not be available. Switching to the correct Tracking plan will enable API access. Additionally, legacy users on older billing systems may still see the Pro plan listed on their upgrade screens.
Note that the Pro plan has been discontinued for new users, and Premium is now the entry point for API access.
If you encounter error messages such as "Failed to save" or notice that the Create/Save option is greyed out, this indicates that your current plan does not support API access. Upgrading to a Premium or higher plan will resolve these issues.
2. Is there a plan solely for API access?
No, there isn’t a dedicated API-only plan. API access is bundled with Premium and higher-tier plans. Choose a plan based on your shipment tracking needs. Historically, the Pro plan was the lowest tier to include API access, but it has since been discontinued. Premium is now the lowest available tier for API access.
3. Can I use an existing API key if I downgrade my plan?
Tracking API: Your existing API key can be used with the Tracking API, even if you are not on the Returns Enterprise plan.
Returns API: Access to the Returns API requires the Returns Enterprise plan.
4. Does the Essentials plan include webhook access?
No, webhook access is also unavailable on the Essentials plan. Upgrade to Premium or higher to use webhooks.
By understanding the plan requirements and available alternatives, you can choose the best option for your shipment tracking needs.