HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
Documentation
Developer HubAPI StatusSupport

SP-API for Vendors - Reports FAQ

Frequently asked questions about SP-API Vendors Reports.

Why is Lost Buy Box Price (LBB Price) not available in API 2.0 reports?

Select to expand the answer LBB (Price) is no longer supported by the Amazon Retail Pricing team, and we will not be able to provide an LBB metric in the vendor retail analytics report types until an effective replacement metric is available. An alternative metric is in development, but we have not received guidance as to when we will be able to share that metric externally.

Why aren’t Conversion and Average Sale Price (ASP) included in reporting?

Select to expand the answer Conversion and ASP are derived metrics, meaning that they can be calculated using other metrics already provided. Use the following equations to calculate these metrics:

Ordered Units/Glance Views = Conversion
Shipped Revenue/Shipped Units = ASP

Are Warehouse Deals sales included in metrics?

Select to expand the answer No, vendor retail analytics report types do not include Warehouse Deals in reported metrics. Because proceeds from Warehouse Deals sales are not collected by the vendor, we do not account for these transactions. Note that the internal tools used by your retail partners might include Warehouse Deals sales. To determine whether Warehouse Deals sales are included in your internal metrics, reach out to your retail partners.

How are Glance Views calculated?

Select to expand the answer Glance Views (GVs) are calculated at the ASIN-level, and only when retail is the featured merchant. By exposing raw GVs when retail is the featured merchant, we provide vendors with traffic data from when retail had the opportunity to convert a sale.

Why doesn't the Glance View metric match the Advertising reports metric?

Select to expand the answer Glance view (GV) metrics can vary based on the reporting tool used and the specific inputs or filters applied to those metrics. For example, Advertising can track impressions and clicks to evaluate the efficacy of an ad directing the shopper to the shelf (in other words, all detail page views). In contrast, the data in vendor retail analytics report types tracks customer traffic directed to a detail page where retail is the feature offer and the vendor has the opportunity to convert a sale. GV metrics can vary across reporting tools.

What if the purchase orders I receive from Amazon do not align with the unit forecast in the forecasting data?

Select to expand the answer The forecasting data provides a forecast for customer demand, not a promise of purchase orders. Customer demand forecasts provide visibility into expected customer demand for a given product and helps manufacturers make informed production and inventory decisions.

What is the difference between distributorView: MANUFACTURING and distributorView: SOURCING?

Select to expand the answer The manufacturing view shows data for Amazon Standard Identification Numbers (ASINs) of items manufactured by you, regardless of who sourced the products to Amazon. The sourcing view only shows data for ASINs of items sourced directly from your vendor group.

Which Amazon selling programs does sellingProgram:RETAIL include?

Select to expand the answer Amazon RETAIL includes data from Amazon Retail, Amazon Business, and Amazon Fresh.

Will vendors still be able to receive and confirm their Purchase Orders (POs) through Electronic Data Interchange (EDI)?

Select to expand the answer Yes. While the Sales and Inventory Report (X12 852, EDIFACT SLSRPT) and Forecast Report (X12 830, EDIFACT DELFOR) EDI transactions will no longer work after June 30, 2022, this will not impact any other EDI transactions such as Purchase Order (X12 850, EDIFACT ORDERS), Purchase Order Acknowledgement (X12 855, EDIFACT ORDRSP), Advanced Shipment Notification (X12 856, EDIFACT DESADV), or other transactions. You can manage all supply chain messages via EDI, but will need to utilize vendor retail analytics report types for your reporting needs in parallel. Alternatively, vendors can migrate other EDI messaging to API as well.

Refer to What is the Selling Partner API? for additional info on migrating EDI messaging to API report types; including purchase order management.

How long does it take for vendors to onboard to SP-API and vendor retail analytics reports?

Select to expand the answer While total onboarding time will vary by vendor, the development effort for vendor retail analytics report onboarding is approximately 4-5 development weeks.
  1. Initial SP-API setup (1-2 weeks), as documented in the SP-API Registration overview.
  2. Building and testing REST clients for SP-API (1 week). Development time can be shortened by using a pre-built library (example).
  3. Periodic fetching of SP-API reports, uploading to a client owned S3 bucket, and any necessary JSON conversions (1 week).
  4. S3 to database (such as Redshift) loading (1 week). Development time can be shortened by using a pre-existing solution (example).

How can vendors disable their EDI sales and forecasting integration?

Select to expand the answer No action is required to disable EDI sales and forecasting integration. After June 30, 2022, the Sales and Inventory Report (X12 852, EDIFACT SLSRPT) and Forecast Report (X12 830, EDIFACT DELFOR) EDI transactions will no longer be published.

Where can vendors get additional support for questions about SP-API integration?

Select to expand the answer

For additional questions on vendor retail analytics report types, refer to the SP-API documentation or Contact Us (Contact Us > API Integration > API Services).

Why are we migrating from API 1.0 to 2.0?

Select to expand the answer Data differences between external API reporting and internal retail reporting are the biggest reporting pain point for both vendors and retail stakeholders. The 1.0 to 2.0 migration aligns data that is shared between API report types and internal retail reporting tools. With the transition to API 2.0 report types, we are migrating to a new data source, thus achieving data parity with internal retail reporting.

What are the benefits of the new API 2.0 report types, compared to API 1.0?

Select to expand the answer With the transition to API 2.0 report types, we are migrating to a new data source, thus providing the following benefits:

  • Source data parity: the new source data for API 2.0 report types is now the same source used by Amazon retail category teams, as well as the retail analytics dashboards in Vendor Central.

  • Expanded historical daily data: daily historic data now increases from 13 months to three years, providing vendors increased visibility into their business historically.

When will the API 1.0 reports be retired?

Select to expand the answer Starting July 6, 2022 the legacy API 1.0 reports will no longer be available.

Which reports are being deprecated and what are their replacements?

Select to expand the answer
API Reports (Deprecated)API 2.0 Reports (Replacement)
GET_VENDOR_SALES_DIAGNOSTIC_REPORTGET_VENDOR_SALES_REPORT and GET_VENDOR_TRAFFIC_REPORT
GET_VENDOR_DEMAND_FORECAST_REPORTGET_VENDOR_FORECASTING_REPORT
GET_VENDOR_INVENTORY_HEALTH_AND_PLANNINGGET_VENDOR_INVENTORY_REPORT

What if I try to access an API 1.0 report after July 6, 2022?

Select to expand the answer Beginning July 6, 2022, users who try to access API 1.0 report types will receive the following error message:

  • Sales 1.0: {"reportRequestError":"This report is now deprecated. Make a request for GET_VENDOR_SALES_REPORT and GET_VENDOR_TRAFFIC_REPORT"}

  • Demand Forecast 1.0: {"reportRequestError":"This report is now deprecated. Make a request for GET_VENDOR_FORECASTING_REPORT"}

  • Inventory 1.0: {"reportRequestError":"This report is now deprecated. Make a request for GET_VENDOR_INVENTORY_REPORT"}

Are extensions available to allow staying on API 1.0?

Select to expand the answer No. Extensions will not be available to stay on API 1.0 report types. Users are encouraged to migrate to the API 2.0 report types.

How do I migrate to API 2.0 report types?

Select to expand the answer

For migration guidance, refer to the Vendor Retail Analytics Reports Migration Guide, available in the SP-API documentation or Contact Us (Contact Us > API Integration > API Services).

Why are some metrics in API 1.0 report types no longer available in API 2.0 report types?

Select to expand the answer

Some of the metrics that were available in the legacy data source backing API 1.0 report types are not available in the new data sourcing powering API 2.0 report types. If you have a specific business use case for a metric no longer available in an API 2.0 report type, share your feedback with us at [email protected].

Why isn't there an Out of Stock Metric in the API 2.0 report types?

Select to expand the answer In order to align with the out of stock metric used by retail teams, we are replacing Replenishable OOS (Rep OOS) with Procurable Product OOS (Retail OOS, or ROOS). ROOS will be added to the GET_VENDOR_INVENTORY_REPORT in Q3 2022. While Rep OOS considers only Replenishable ASINs, ROOS considers Procurable ASINs.

When should I expect API 2.0 report types to update?

Select to expand the answer The service-level agreement (SLA) for weekly reporting periods (such as Saturday datasets) is 48 hours after close of period by end of day (EOD) on Mondays. The SLA for non-Saturday daily reporting periods is 72 hours after close of period.
DashboardAverage SLA (hrs)TP90 SLA (hrs)
Sales4255
Traffic3251
Net PPM4155
Inventory5469
Forecasting3340

Why is inventory data not available at daily granularity in API 2.0?

Select to expand the answer With the new data source, not all inventory metrics are available at the daily granularity. Reports are only provided at the lowest shared granularity of all metrics. Therefore, for the short term, we are unable to provide a daily grain inventory report without removing the metrics which are only available weekly. Metrics only available weekly include: `sellThroughRate`, `unhealthyInventory`, and `unhealthyUnits`. We are evaluating how we can provide the inventory report at a daily granularity in the future.

Where can vendors go for additional support and questions on API integration?

For additional questions on API integration, refer to the SP-API documentation or Contact Us (Contact Us > API Integration > API Services).

Updated about 1 month ago