Skip to main content

API Migration Guide

Guide to migrating between API versions.

Migration Checklist​

  • Review API changelog
  • Update endpoint URLs
  • Update request/response formats
  • Update authentication
  • Test all endpoints
  • Update error handling

Common Migration Tasks​

Endpoint Updates​

Update endpoint URLs:

// Old: /api/v1/products
// New: /shopfront/api/v2/products
const endpoint = '/shopfront/api/v2/products';

Request Format Updates​

Update request formats:

// Check API documentation for format changes
const request = {
  // Updated format
};