A collection of Amazon Marketplace data objects.
This package is written in TypeScript and is fully typed.
This package combines data about Amazon Marketplace (the consumer side of Amazon) into a structured class.
- ID (e.g.
A2EUQ1WTGCTBG2
) - Country code (ISO 3166-1) (e.g.
CA
) - Currency code (ISO 4217) (e.g.
CAD
) - Name (country name) (e.g.
Canada
) - URI (e.g.
https://www.amazon.ca/
) - Amazon Marketplace Web Service (Amazon MWS) endpoint URI
- Amazon Advertising
- API endpoint URI
- Sponsored products
- Minimum bid
- Maximum bid
- Sponsored Brands
- Minimum bid
- Maximum bid
- Account time zone
import { amazonMarketplaces } from '@scaleleap/amazon-marketplaces'
console.log(
'Amazon Marketplace %s has currency %s.',
amazonMarketplaces.CA.name,
amazonMarketplaces.CA.currency
)
import { amazonMarketplacesList } from '@scaleleap/amazon-marketplaces'
const marketplaceIds = amazonMarketplacesList.map(marketplace => marketplace.id)
import {
findAmazonMarketplace,
findAmazonMarketplaceOrFail,
AmazonMarketplaceAdvertisingCountryCode
} from '@scaleleap/amazon-marketplaces'
// Return value *can* be undefined
const CA = findAmazonMarketplace('countryCode', AmazonMarketplaceAdvertisingCountryCode.CA)
// Function will throw an error if marketplace is not found
// Thus return value is never undefined.
const US = findAmazonMarketplaceOrFail('countryCode', AmazonMarketplaceAdvertisingCountryCode.US)
{
"countryCode": "CA",
"currency": "CAD",
"id": "A2EUQ1WTGCTBG2",
"name": "Canada",
"uri": "https://www.amazon.ca",
"webServiceUri": "https://mws.amazonservices.ca",
"advertising": {
"uri": "https://advertising-api.amazon.com",
"bids": {
"sponsoredBrands": {
"min": 10,
"max": 4900
},
"sponsoredProducts": {
"min": 2,
"max": 100000
}
},
"timeZone": "America/Los_Angeles"
}
}
$ npm i -s @scaleleap/amazon-marketplaces
If you find any other data that can be added, please open an issue and let us know.
Note that this repository uses Conventional Commit style commit messages.
If a new marketplace is added, this should be marked as breaking change and increase the major version, because others may rely on iterating over the available marketplaces.
- Amazon Advertising API
- Amazon Marketplace Web Service
- ISO 4217
- Regional profile time zone codes
- List of tz database time zones
- Roman Filippov (Scale Leap)
This project is licensed under the MIT License.