Understanding Versions
When working with CreatorsAPI, you'll encounter several different version numbers. Here's what each one means:
Version Types
| Version Type | Example | Where Used | Purpose | Notes |
|---|---|---|---|---|
| Credential Version | 2.1, 3.1 | Authorization header for API requests | Specifies which credential format to use for authentication | Automatically assigned when creating credentials based on your store's home region (NA: 2.1/3.1, EU: 2.2/3.2, FE: 2.3/3.3). The version determines which token endpoint to use for authentication — it does not restrict which marketplaces you can access. Credentials work globally across all marketplaces, provided you have a valid Partner Tag and Creators API access approved for the target region. v2.x uses Cognito, v3.x uses LwA. |
| SDK Version | 1.1.2 | SDK Package | Tracks which version of the SDK library you are using | Follows semantic versioning (MAJOR.MINOR.PATCH); see SDK Changelog |
| API Version | v1 | Endpoint URL path | Identifies which version of the API endpoints to call | Determines available operations and features; current version is v1 |
| Resource Version | OffersV2 | Response data structures | Specifies which version of the data format you want returned | Use newer versions like OffersV2 for improved data quality and additional fields |
Quick Reference
Credential Version
Authorization: Bearer YOUR_ACCESS_TOKEN, Version 2.1
// Used in Authorization header when making API requests
API Version in Endpoint URLs
/catalog/v1/getItems/catalog/v1/searchItems/catalog/v1/getBrowseNodes/catalog/v1/getVariations
Resource Version in Requests
{
"itemIds": ["B08N5WRWNW"],
"resources": [
"offersV2.listings.price",
"offersV2.listings.availability"
]
}
Related Documentation
Using SDK - SDK setup and changelog
Register for Creators API - Credential generation
OffersV2 Resources - Enhanced offers documentation
API Reference - Complete API documentation
