Selling Partner API Roles
Learn how to use roles in the Selling Partner API.
Roles are the mechanism by which the Selling Partner API (SP-API) determines whether a developer or application has access to an operation or resource. Roles protect access to personally identifiable information (PII) and other sensitive data, and ensure that developers only access data that their application requires.
As a developer, you must request and qualify for a particular role to gain access to the operations and resources that the role provides. Use the following topics to identify which role you need for each SP-API operation and type:
Role definitions
In the following sections, Restricted means that the role requires sensitive information, which might include personally identifiable information (PII). For these roles, you must provide additional information about your data use and security controls.
Account Information Service Provider
The Account Information Service Provider (AISP) role provides access to information about the Amazon Selling Partner account, including information about the seller's business and the marketplaces where the seller account is active. You can use this role to view payment methods and financial events for the seller.
Select for examples of operations that require this role.
- The
getAccount
operation of the Sellers API v1, which gets information about a seller account and its marketplaces. - The
getPaymentMethods
operation of the Transfers API v2024-06-01, which returns a list of payment methods for the seller.
Amazon Fulfillment
The Amazon Fulfillment role provides access to Amazon fulfillment operations and shipping services such as Fulfillment by Amazon (FBA) and Amazon Fulfillment Network (AFN). You generally use this role for FBA sales reports, order tracking reports, and operations related to order fulfillment.
Select for examples of operations that require this role.
- The
createReport
operation of the Reports API v2021-06-30, when you request the FBA Fee Preview report. This report contains the estimated Amazon selling and fulfillment fees for the seller's FBA inventory with active offers. - The
getSubscription
operation of the Notifications API v1, when you subscribe toFBA_OUTBOUND_SHIPMENT_STATUS
notifications. These notifications signify when Amazon creates or cancels a Fulfillment by Amazon shipment for a seller. - The
listShipmentItems
operation of the Fulfillment Inbound API v2024-03-20, which returns a list of packages in a shipment. - The
createFeed
operation of the Feeds API v2021-06-30, when you submit aPOST_FBA_INBOUND_CARTON_CONTENTS
feed. This feed lets you submit carton content information when shipping inventory to Amazon’s fulfillment network.
Amazon Warehousing and Distribution
The Amazon Warehousing and Distribution (AWD) role provides access to AWD shipment and inventory operations. You generally use this role when you use the Amazon Warehousing and Distribution API to interact with AWD inventory information and shipment details.
Select for examples of operations that require this role.
- The
listInventory
operation of the Amazon Warehousing and Distribution API v2024-05-09, which returns inventory levels and states for products in AWD. - The
getInboundShipment
operation of the Amazon Warehousing and Distribution API v2024-05-09, which returns shipment details such as the status and received quantities for reconciliation.
Brand Analytics
The Brand Analytics role provides access to marketplace analytics reports, such as seller and vendor performance metrics and consumer behavior insights that show how customers discover and purchase products on Amazon.
Select for examples of operations that require this role.
- The
createReport
operation of the Reports API v2021-06-30, when you request theGET_BRAND_ANALYTICS_SEARCH_TERMS_REPORT
report. This report returns data on the top-clicked ASINs by search keyword and department for a marketplace. - The
createReport
operation of the Reports API v2021-06-30, when you request theGET_PROMOTION_PERFORMANCE_REPORT
report. This report returns data from promotion campaigns to help vendors and sellers optimize their promotions and adjust their advertising strategies.
Buyer Communication
The Buyer Communication role provides access to operations that manage messaging to and from Amazon buyers. You generally use this role when you use the Messaging API to message Amazon buyers.
Select for examples of operations that require this role.
- The
getMessagingActionsForOrder
operation of the Messaging API v1, which returns a list of message types available for a specified order. - The
createConfirmOrderDetails
operation of the Messaging API v1, which sends a message to ask a buyer an order-related question prior to shipping. - The
createConfirmDeliveryDetails
operation of the Messaging API v1, which sends a message to a buyer to arrange a deliver or confirm contact information for making a delivery.
Buyer Solicitation
The Buyer Solicitation role provides access to buyer feedback solicitation operations. You generally use this role when you use the Solicitations API to solicit Amazon buyers for feedback.
Select for examples of operations that require this role.
- The
getSolicitationActionsForOrder
operation of the Solicitations API v1, which returns a list of solicitation types that are available for an order. - The
createProductReviewAndSellerFeedbackSolicitation
operation of the Solicitations API v1, which sends a solicitation to a buyer asking for feedback and a product review for an order.
Direct-to-Consumer Shipping (Restricted)
The Direct-to-Consumer Shipping (Restricted) role provides access to operations that ship orders directly to customers using their carrier of choice, including Amazon. Operations that require this role use PII to enable shipping. You generally use this role to request order reports, order tracking reports, EasyShip, and for operations that relate to shipping orders placed on Amazon.
Select for examples of operations that require this role.
- The
getOrders
operation of the Orders API v0, which returns a list of orders and order information based on criteria that you specify. - The
createReport
operation of the Reports API v2021-06-30, when you request theGET_FLAT_FILE_ ORDER_REPORT_DATA_SHIPPING
report. - The
createFeed
operation of the Feeds API v2021-06-30, when you submit aPOST_ORDER_FULFILLMENT_DATA
feed. This feed allows your system to update Amazon's system with order fulfillment information.
Finance and Accounting
The Finance and Accounting role provides access to operations that create accounting and financial statements.
Select for examples of operations that require this role.
- The
getReports
operation of the Reports API v2021-06-30, to return a list of Flat File V2 Settlement reports. - The
getSubscription
operation of the Notifications API v1, when you request information about subscriptions to theFEE_PROMOTION
notification type.
Inventory and Order Tracking
The Inventory and Order Tracking role provides access to operations that analyze and manage inventory. You generally use this role to get FBA sales reports, order tracking reports, and operations related to orders, vendor orders, sales order metrics, and inventory management. Operations that require this role do not use PII required to ship an order. Rather, this role is for applications that track shipments.
Select for examples of operations that require this role.
- The
getOrderMetrics
operation of the Sales API v1, which returns aggregated order metrics. - The
createReport
operation of the Reports API v2021-06-30, when you request theGET_MERCHANT_LISTINGS_DATA
report. This report returns detailed active listings. - The
createFeed
operation of the Feeds API v2021-06-30, when you submit aPOST_FLAT_FILE_FULFILLMENT_DATA
feed. This feed lets you submit order fulfillment information to Amazon.
Notifications in Seller Central
The Notifications in Seller Central role provides access to operations that send targeted notifications to sellers within Seller Central. For example, you can use the App Integrations API to send notifications that inform the seller about their business or to encourage the seller to take action on your website.
Select for examples of operations that require this role.
- The
createNotification
operation of the App Integrations API v2024-04-01 creates and sends a notification to sellers with information relevant to their business. - The
deleteNotifications
operation of the App Integrations API v2024-04-01 deletes a notification that was previously sent to a seller.
Payment Initiation Service Provider
The Payment Initiation Service Provider (PISP) role provides access to operations that initiate the payout to the seller's deposit method and the issuance of a refund (adjustment) for an order.
Select for examples of operations that require this role.
- The
initiatePayout
operation of the Transfers API v2024-06-01, which initiates an on-demand payout to the seller's default deposit method. - The
createFeed
operation of the Feeds API v2021-06-30, when you submit aPOST_FLAT_FILE_PAYMENT_ADJUSTMENT_DATA
feed.
Pricing
The Pricing role provides access to operations that determine list prices and automate product pricing. You generally use this role for pricing-related reports, feeds, and operations.
Select for examples of operations that require this role.
- The
getPricing
operation of the Product Pricing API v2022-05-01, which returns pricing information for a seller's offer listings. - The
createFeed
operation of the Feeds API v2021-06-30, when you submit aRFQ_UPLOAD_FEED
feed. This feed lets you upload quantity discounts in response to requests from business customers. - The
createReport
operation of the Reports API v2021-06-30, when you request theGET_MERCHANT_CANCELLED_LISTINGS_DATA
report. This report returns canceled listings.
Product Listing
The Product Listing role provides access to operations that create and manage product listings. You generally use this role for product-catalog-related reports, feeds, and operations.
Select for examples of operations that require this role.
- The
getCatalogItem
operation of the Catalog Items API v2022-04-01, which returns information about the item indicated and its attributes. - The
createReport
operation of the Reports API v2021-06-30, when you request theGET_MERCHANT_LISTINGS_INACTIVE_DATA
report. This report returns detailed inactive listings. - The
getMyFeesEstimateForSKU
operation of the Product Fees API v0, which returns the estimated fees for the item indicated.
Professional Services (Restricted)
The Professional Services (Restricted) role provides access to operations that provide add-on services such as assembly and installation to Amazon buyers. You generally use this role when you use the Services API v1.
Select for examples of operations that require this role.
- The
getServiceJobs
operation of the Services API v1, which returns a list of service job details for the specified filter query. - The
addAppointmentForServiceJobByServiceJobId
operation of the Services API v1, which adds an appointment to the service job indicated by the service job identifier specified.
Selling Partner Insights
The Selling Partner Insights role provides access to operations that retrieve information about a selling partner's account and performance.
Select for examples of operations that require this role.
- The
getMarketplaceParticipations
operation of the Sellers API v1, which returns a list of marketplaces that a seller can sell in, and information about the seller's participation in those marketplaces. - The
createReport
operation of the Reports API v2021-06-30, when you request theGET_V1_SELLER_PERFORMANCE_REPORT
report. This report contains individual performance metrics from the Seller Central dashboard.
Tax Invoicing (Restricted)
The Tax Invoicing (Restricted) role provides access to operations that generate tax invoices to comply with tax regulation. Operations that require this role require PII to enable tax invoice generation. You generally use this role for tax reports, order reports, and operations that return information about orders.
Select for examples of operations that require this role.
- The
getOrderBuyerInfo
operation of the Orders API v0, which returns buyer information for an order. - The
createReport
operation of the Reports API v2021-06-30, when you request theGET_FLAT_FILE_VAT_INVOICE_DATA_REPORT
report. - The
createReport
operation of the Reports API v2021-06-30, when you request theGET_EASYSHIP_DOCUMENTS
report. This report contains the invoice, shipping label and warranty documents for an Easy Ship order.
Tax Remittance (Restricted)
The Tax Remittance (Restricted) role provides access to operations that calculate and remit sales taxes. Operations that require this role might use PII to calculate sales taxes. You generally use this role for FBA sales reports, order reports, and operations that return information about orders.
Select for examples of operations that require this role.
- The
getOrderItems
operation of the Orders API v0, which returns detailed item information for an order. - The
getOrderAddress
operation of the Orders API v0, which returns the shipping address for an order. - The
createReport
operation of the Reports API v2021-06-30, when you request theGET_ORDER_REPORT_DATA_TAX
report.
Updated 3 days ago