Skip to main content
This page documents breaking changes and migration steps when upgrading the Crave Storefront SDK or API.

​
SDK v1.x (Current)

The current stable release. No breaking changes since initial release.

​
Installation

pnpm add @craveup/storefront-sdk@latest

​
Changelog highlights

VersionChange
1.3.0Added storefront.locations.getDistance() for delivery zone checks
1.2.0Added storefront.analyticsEvents namespace for funnel tracking
1.1.0Added storefront.cart.getRecommendations() for upsell suggestions
1.0.0Initial release — 8 namespaces, 30+ methods

​
API versioning

The API is versioned via the URL path: 
https://api.craveup.com/api/v1/...
When a new API version is released, the previous version will remain available for at least 12 months with security patches. New features are only added to the latest version.

​
Checking your API version

The response includes a X-API-Version header: 
X-API-Version: 2025-01-01

​
General upgrade checklist

When upgrading the SDK:
  1. Read the changelog for the versions you’re skipping
  2. Update the package: pnpm add @craveup/storefront-sdk@latest
  3. Run pnpm typecheck — TypeScript will catch removed or renamed methods
  4. Test the full ordering flow in test mode (session → cart → checkout → payment)
  5. Verify webhook handlers still work with current payload formats

​
Future breaking changes

When breaking changes are planned, they will be:
  1. Announced in the Changelog at least 30 days in advance
  2. Documented on this page with migration instructions
  3. Released under a new API version (v2)
  4. The old version (v1) will continue working for 12 months
Subscribe to the Changelog RSS feed to get notified of updates.

Slack Community

Ask questions and get help from the Crave team and community.

Discord

Join our Discord server for real-time discussions.

Email Support

Reach out to hello@craveup.com for direct support.