Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
ApiClient
✓ import { ApiClient } from 'amazon-creators-api'
✗ const ApiClient = require('amazon-creators-api').ApiClient
ESM-only package; CJS require() works but is not recommended.
GetItemsRequestContent
✓ import { GetItemsRequestContent } from 'amazon-creators-api'
✗ import GetItemsRequestContent from 'amazon-creators-api'
Named export, not default.
TypedDefaultApi
✓ import { TypedDefaultApi } from 'amazon-creators-api'
Main typed API class.
GetItemsResource
✓ import { GetItemsResource } from 'amazon-creators-api'
✗ import { GetItemsResourceEnum } from 'amazon-creators-api'
Enum named GetItemsResource, not GetItemsResourceEnum.
Initializes the Creators API client, authenticates with credentials from environment variables, and fetches product details for a list of ASINs.
import { ApiClient, GetItemsRequestContent, GetItemsResource, TypedDefaultApi } from 'amazon-creators-api';
const apiClient = new ApiClient();
apiClient.credentialId = process.env.CREDENTIAL_ID ?? '';
apiClient.credentialSecret = process.env.CREDENTIAL_SECRET ?? '';
apiClient.version = process.env.CREDENTIAL_VERSION ?? '';
const api = new TypedDefaultApi(apiClient);
async function getItems(): Promise<void> {
const marketplace = 'www.amazon.com';
const partnerTag = process.env.PARTNER_TAG ?? '';
const itemIds: string[] = ['B0DLFMFBJW', 'B0BFC7WQ6R', 'B00ZV9RDKK'];
const request = new GetItemsRequestContent(partnerTag, itemIds);
const resources = [
'images.primary.medium',
'itemInfo.title',
'itemInfo.features',
'offersV2.listings.price',
'offersV2.listings.availability',
'offersV2.listings.condition',
'offersV2.listings.merchantInfo',
].map(r => GetItemsResource.constructFromObject(r));
request.resources = resources;
try {
const response = await api.getItems(marketplace, request);
console.log('Response:', JSON.stringify(response, null, 2));
} catch (err) {
console.error('Error:', err);
}
}
getItems();
Errors
Common errors & fixes
TypeError: Cannot read properties of undefined (reading 'credentialId')
ApiClient instance is not properly instantiated or credentials are not set.
fixEnsure you create a new ApiClient() and set credentialId, credentialSecret, and version.
Error: A required parameter marketplace was not specified
Marketplace parameter is missing in API call.
fixProvide a valid marketplace string (e.g., 'www.amazon.com') as first argument to getItems().
Error: Invalid partner tag
Partner tag is invalid or not provided.
fixCheck your Amazon affiliate tracking ID and pass it correctly as the first argument to GetItemsRequestContent.
Audit
Dependencies
No dependency data recorded yet.