Frequently Asked Questions
What is PA API 5.0?
PA API 5.0 (PA API 5) is the latest version of the Product Advertising API. It has been upgraded from prior version PA API 4 to give access to the latest retail product information. PA API 5 is available in United States (US), Canada (CA), Mexico (MX), Brazil (BR), United Kingdom (UK), Germany (DE), Spain (ES), France (FR), India (IN), Italy (IT), United Arab Emirates (AE), Turkey (TR), Japan (JP), and Australia (AU) marketplaces. All new marketplaces will only be supported in PA API 5. See Locale Reference for more details.
I am using PA API 4. Why do I need to upgrade to newer version of PA API?
PA API 5 gives you access to the latest features that can give you not only the most important features available in PA API 4 but also new features that are added to Amazon’s products. These new capabilities will help you deliver improved shopping experiences to your customers. PA API 5 has new support for developers to easily integrate with the API and reduce time to develop your applications and sites. All future product enhancements will made available only through PA API 5. For detailed list of new features, please see the questions below and documentation. PA API 4 is built on technology that is being deprecated. We will be shutting down PA API 4 on February 11, 2020. All your applications and sites using PA API 4 will not work as expected after that. Hence, it is important to upgrade to latest version of PA API.
What is the business value of upgrading to PA API 5 to an Associate?
PA API 5 is an API to help you as an Associate to advertise products and earn commission as a result. It gives you the following benefits:
- Increase your ability to monetize your site and social media posts by selling products available on Amazon through your site, using global scale Amazon Product Advertising API (PA API 5) and web service.
- Access information about the latest offers and products in the entire Amazon product database / catalog.
- Newer, improved ways to get most relevant product information to advertise.
- Rapid integration and easier development with lower engineering cost through use of popular tools and languages.
- Upgrade from PA API 4 before the service is turned off to avoid downtime and loss of revenue.
- NEW! Access the most relevant product data available on Amazon's retail site: information on new offerings like Prime, Free Shipping, etc. are available through PA API 5.
- NEW! Discover products and offers using better search results of products for your content research by filtering for Prime, FulfillmentByAmazon and additional programs.
- IMPROVED! Identify the best products to promote using more granular sales ranks within categories.
- NEW! Scale to global markets by globalizing and regionalizing your content - multiple currencies and multiple languages.
- NEW! Find more offers and promotions information - PA API 5 returns new offer information such as SubscribeAndSave promotion with discounted pricing.
- Get programmatic access to the latest Amazon product offerings using information about item attributes, offers, images, sales ranks.
- NEW! Promote products that are in Prime exclusive, PrimePantry, Fulfilled by Amazon programs to improve your conversion among Amazon customers.
- NEW! For global customers, retrieve price information in currency format and product information in language of choice to target global marketplaces.
What is the technical benefit of upgrading to PA API 5 as a developer?
- IMPROVED! Identify the best products to promote using more granular sales ranks within categories - PA API 5 now returns sales rank information against each category in consistent format as you see on Amazon's product page. (PA API 4 only had a single rank.)
- NEW! Flexibility of data processing using JSON interchange format which is more readable, faster, more flexible in processing and much lighter.
- NEW! PA API 5 uses the latest AWS signature version 4 that provides improved security by using a signing key instead of your secret access keys.
If I am a PA API user today, what do I have to do to upgrade to PA API 5?
If you use PA API 4 today, you can upgrade to PA API 5 using the following steps.
- If you are using old AWS credentials migrate your account to new PA API account.
- Get new credentials from Associate Central.
- Test PA API 5 using Scratchpad.
- Update all your applications and sites to integrate with PA API 5 APIs replacing PA API 4.
- Test and deploy your newly upgraded application. A detailed guide is available in Migration guide.
Does this mean that to upgrade my PA API 4 site to PA API 5, I will have to update my site or application?
Yes, if you are already using PA API 4, you will have to update your site or application using PA API 5 to replace all PA API 4 API calls with equivalent PA API 5 APIs. For your benefit, we have provided a simple table mapping the PA API 4 API calls to PA API 5 API calls in the migration guide.
How much effort and time will be required to upgrade to PA API 5 from PA API 4?
The effort and time required to upgrade to PA API 5 will depend on the complexity of your site or application. We cannot accurately provide this information. We have found that it takes 3 or 4 weeks to make changes to a typical application to upgrade from PA API 4 to PA API 5. The time for testing and deployment depends on your individual installations. During the upgrade period from now until February 11, 2020 you can access both PA API 4 and PA API 5. To make it easier, we have provided documentation with troubleshooting. You can also contact us on the email provided in the FAQ.
Do I need new credentials to access PA API 5 or can I use my old ones?
If you have generated credentials after September 30th 2017, there is no action required from you. If you have generated credentials before September 29th 2017, please visit Associates Central’s PA API page and click the “migrate now” button which will refresh your credentials with ones that are compatible with PA API 5. Make sure you login with your primary owner account. See Migrating your account for more information. Please ensure you update all your existing credential stores and configuration files immediately, to continue successfully using PA API.
I do not remember if I generated new credentials. How do I know if I have old or new credentials?
The easiest way to test PA API is to use look at the PA API page on the Associates Central. Make sure you login with your primary owner account.
- Please use PA API 5 Scratchpad to check if your credentials are compatible with PA API 5. Use “Start Tour” option to get tour of the Scratchpad, if you have any questions refer Scratchpad usage guide section.
- If you are getting “AccessDeniedException” with “AccessDeniedAwsUsers” code, please visit PA API tab on Associates Central website and migrate your credential.
- If you are not getting above exception play around with the Scratchpad to see functionality provided in PA API 5.
- During your application development if you ever want to debug your application, you can use Scratchpad to confirm API’s responses. More details in the question relating to ‘additional help’.
Can I use the new credentials to access PA API 4?
Yes, you can use the new credentials to access PA API 4. You may do so until PA API 4 access is shutdown on February 11, 2020. You can also continue to use the old credentials with PA API 4 until it is available. But rather than managing two sets of credentials – old and new, you can use the new credentials with all PA API versions.
If I have upgraded to PA API 5, can I roll back to PA API 4?
Once you have upgraded to PA API 5, you can continue to use both PA API 5 and PA API 4. This will allow you to use both systems in parallel for testing while you are upgrading preventing any downtime. On February 11, 2020, we will be shutting down PA API 4 after which you will not be able to use it. You can continue to use PA API 5 with the latest credentials.
When I upgrade to PA API 5, do the efficiency guidelines apply?
Yes, once you have upgraded to PA API 5, the same Efficiency guidelines and limits apply.
I have never used PA API. What do I have to do to use PA API 5?
If you signed up to be part of Amazon Associate program and your account is approved, you will can request for access to PA API. Once you get the credentials from Associates Central you can use it to call PA API 5. For more information see Register for PA API.
If I generate new credentials to start upgrading to PA API 5 how long will my old credentials work with my existing PA API 4 integration?
Your old credentials will work with PA API 4 till it is shutdown.
Can I still access PA API 4 using new credentials?
You can use new credentials to access PA API 4, till it is shutdown.
I currently use AWS Signature V2 to generate signed requests. Do I need to migrate to AWS Signature V4 to make request to PA API 4?
You will continue to use existing AWS signature V2 mechanism while signing request for PA API 4, even with old or new credentials. While signing request for PA API 5 you will need to sign using AWS Signature V4 mechanism. You can use PA API 5 SDK to make requests to PA API 5 which takes care of signing request on your behalf.
If I have registered as Associate in multiple marketplace with same email id, then do I need to generate credentials in each marketplaces on Associate Central website?
With PA API 5 you can access all the marketplace except JP using the same set of credentials, if you have the approved stores in the marketplace with same primary owner (email id). For JP you need a separate set of credentials which you can generate on the JP Associates Central page, which you can use only in JP marketplace. If you have registered as Associate in multiple marketplaces but with different email id, then you need generate credential for each of the email ids.
I am not sure which version of API I am using?
If you are using ItemLookup, ItemSearch, SimilarityLookup, CartCreate, CartAdd, CartGet, CartModify, CartClear then you are using PA API 4, else PA API 5. If you are getting response in XML then you are using PA API 4, if JSON then PA API 5. If you are using any of software/plug-in by external/third-party provider, please check with them for the details.
When will SDK’s be uploaded to third party repositories and Github?
We are working on this and will upload them soon.
Can I get Power Search support in PA API 5?
Power Search is deprecated, it'll not be supported in PA API 5.
Is there Batching support in PA API 5?
With PA API 5 you can specify multiple item ids (upto 10) for GetItems API and multiple BrowseNode Ids (upto 10) for GetBrowseNodes API.
How do I know if I am using PA API 5 scratchpad?
I can't find migrate button on PAAPI tab of Associate Central website. How can I migrate?
Visit Associate Central website. Login with email id of primary owner of the store. From navigation bar select 'Tools > Product Advertising API'. In 'Manage your credential' section choose to migrate your credentials. Once credentials are generated, start using them with Amazon Product Advertising API 5.0 Scratchpad.
Why am I seeing disabled Join/Migrate button?
PA API 5 is only accessible by the primary owner of the store which is approved. If you are seeing disabled Join/Migrate button or disabled create or add credentials button, make sure your store is in approved status and you are logging into Associates Central with the primary owner of the store.
I am currently using IAM user for generating API keys, do I have to migrate too on Associate Central website by generating new credentials?
How can I check if I have logged in with my primary account?
Sign into Associate Central website, if you can access payment method update and tax interview pages for selected store then you are primary owner of the store.
How can I find primary owner of the store?
You can contact Customer Support using Associate Central website.
I see URL vended in PA API 4 and PA API 5 are different, does attribution work for both of them?
Yes attribution works with both of them. Currently Link Type Report doesn't show PA API 5 data, we will add them soon.
I am looking for Cart functionality which was supported in PA API 4, how can I use Carts?
Cart API support is removed with PA API 5. You can use Add to Cart form.
I used to look up for Item using EAN/UPC/ISBN with ItemLookup API in PA API 4, how does PA API 5 support this use-case?
Please refer Search with external identifiers (UPC/EAN/ISBN) section for more details.
I have questions or have feedback. How can I get additional help?
If you have any questions/feedback, you can get help in any of the following ways:
- The documentation has many examples of using PA API 5.
- For error codes and messages, see Error Handling.
- To create example requests and code samples, see Using the Amazon Product Advertising API 5.0 Scratchpad.
- You can send email for technical help to firstname.lastname@example.org with following information.
- Please include your email id and store id associated with your associate account.
- You should also include your sample request/response along with screenshots for reference.
- Please write your communication in English.