Skip to content
Changelog

Report a bug

Amazon Ads integration: operations for AI agents

Amazon Ads connects to Type.com as an integration. This page lists the 105 operations documented for Claude and Codex in Type.com: 42 read, 55 write, 8 destructive.

About Amazon Ads

Amazon Ads API for campaign, profile, reporting, Sponsored Products, Sponsored Brands, Sponsored Display, and DSP workflows.

Categories: Marketing & Social

How to connect Amazon Ads to Type.com

Connect
OAuth client ID, client secret and refresh token
Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

105 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

105 operations listed.

Brand Store Editions

  • Read

    List Brand Store Edition

    Retrieve brand store page content **Requires one of these permissions**: ["amazon_stores_edit","amazon_stores_view"]

    GET /adsApi/v1/brandStoreEditions

Buyer Seats

  • Read

    List Buyer Seat

    List buyer seats **Requires one of these permissions**: ["campaign_view"]

    GET /adsApi/v1/buyerSeats

  • Write

    Create Buyer Seat

    Create buyer seats for advertisers **Requires one of these permissions**: ["campaign_view"]

    POST /adsApi/v1/create/buyerSeats

Commitments

  • Read

    List Commitment

    List commitments **Requires one of these permissions**: []

    GET /adsApi/v1/commitments

  • Read

    Query Commitment

    Query commitments with filters **Requires one of these permissions**: []

    POST /adsApi/v1/query/commitments

  • Read

    Retrieve Commitment

    Get Commitments **Requires one of these permissions**: []

    POST /adsApi/v1/retrieve/commitments

  • Write

    Create Commitment

    Create commitments **Requires one of these permissions**: []

    POST /adsApi/v1/create/commitments

  • Write

    Update Commitment

    Update commitments **Requires one of these permissions**: []

    POST /adsApi/v1/update/commitments

Ad Associations

  • Read

    Query Ad Association

    Query Ad Association **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["dsp_creatives_view", "creatives_view", "dsp_campaign_view", "campaign_view"]

    POST /adsApi/v1/query/adAssociations

  • Write

    Create Ad Association

    Create Ad Association **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["campaign_edit", "dsp_campaign_edit"]

    POST /adsApi/v1/create/adAssociations

  • Write

    Update Ad Association

    Update Ad Association **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["campaign_edit", "dsp_campaign_edit"]

    POST /adsApi/v1/update/adAssociations

  • Destructive

    Delete Ad Association

    Delete Ad Association **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["campaign_edit", "dsp_campaign_edit"]

    POST /adsApi/v1/delete/adAssociations

Ad Extensions

  • Read

    Query Ad Extension

    Query ad_extension - API is in open beta **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["advertiser_campaign_edit", "advertiser_campaign_view"]

    POST /adsApi/v1/query/adExtensions

  • Write

    Create Ad Extension

    Create ad extensions - API is in open beta **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["advertiser_campaign_edit"]

    POST /adsApi/v1/create/adExtensions

  • Write

    Update Ad Extension

    Update ad_extension - API is in open beta **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["advertiser_campaign_edit"]

    POST /adsApi/v1/update/adExtensions

Ad Groups

  • Read

    Query Ad Group

    List ad groups **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["advertiser_campaign_edit", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view"]

    POST /adsApi/v1/query/adGroups

  • Write

    Create Ad Group

    Create ad groups **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]

    POST /adsApi/v1/create/adGroups

  • Write

    Update Ad Group

    Update ad groups **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Note:** For Amazon DSP, `state` supports only ENABLED and PAUSED; ARCHIVED is not a valid state for DSP ad groups. **Requires one of these permissions**: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]

    POST /adsApi/v1/update/adGroups

  • Destructive

    Delete Ad Group

    Delete ad groups **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["advertiser_campaign_edit"]

    POST /adsApi/v1/delete/adGroups

Ads

  • Read

    Query Ad

    List ads **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["advertiser_campaign_edit", "dsp_creatives_view", "creatives_view", "dsp_creatives_edit", "creatives_edit", "advertiser_campaign_view"]

    POST /adsApi/v1/query/ads

  • Write

    Create Ad

    Create ads **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["advertiser_campaign_edit", "dsp_creatives_edit", "creatives_edit"]

    POST /adsApi/v1/create/ads

  • Write

    Update Ad

    Update ads **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["advertiser_campaign_edit", "dsp_creatives_edit", "creatives_edit"]

    POST /adsApi/v1/update/ads

  • Destructive

    Delete Ad

    Delete ads **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["advertiser_campaign_edit"]

    POST /adsApi/v1/delete/ads

Advertiser Accounts

  • Read

    Query Advertiser Account

    List advertiser accounts **Requires one of these permissions**: []

    POST /adsApi/v1/query/advertiserAccounts

  • Write

    Create Advertiser Account

    Create advertiser accounts **Requires one of these permissions**: []

    POST /adsApi/v1/create/advertiserAccounts

  • Write

    Update Advertiser Account

    Update advertiser accounts **Requires one of these permissions**: []

    POST /adsApi/v1/update/advertiserAccounts

Advertising Deal Targets

  • Write

    SBCreate Advertising Deal Target

    Create advertisingDealTarget **Requires one of these permissions**: ["advertiser_campaign_edit", "advertiser_campaign_view"]

    POST /adsApi/v1/create/advertisingDealTargets/sb

  • Write

    SBDelete Advertising Deal Target

    Delete advertisingDealTarget **Requires one of these permissions**: ["advertiser_campaign_edit", "advertiser_campaign_view"]

    POST /adsApi/v1/delete/advertisingDealTargets/sb

  • Write

    SBQuery Advertising Deal Target

    Query advertisingDealTarget **Requires one of these permissions**: ["advertiser_campaign_edit", "advertiser_campaign_view"]

    POST /adsApi/v1/query/advertisingDealTargets/sb

Advertising Deals

  • Read

    Query Advertising Deal

    Query advertising deals with filters **Requires one of these permissions**: ["inventory_edit", "inventory_view"]

    POST /adsApi/v1/query/advertisingDeals

  • Write

    Create Advertising Deal

    Create advertising deals **Requires one of these permissions**: ["inventory_edit", "inventory_view"]

    POST /adsApi/v1/create/advertisingDeals

  • Write

    SBCreate Advertising Deal

    Create advertisingDeal **Requires one of these permissions**: ["advertiser_campaign_edit", "advertiser_campaign_view"]

    POST /adsApi/v1/create/advertisingDeals/sb

  • Write

    SBDelete Advertising Deal

    Delete advertisingDeal **Requires one of these permissions**: ["advertiser_campaign_edit", "advertiser_campaign_view"]

    POST /adsApi/v1/delete/advertisingDeals/sb

  • Write

    SBQuery Advertising Deal

    Query advertisingDeal **Requires one of these permissions**: ["advertiser_campaign_edit", "advertiser_campaign_view"]

    POST /adsApi/v1/query/advertisingDeals/sb

  • Write

    Update Advertising Deal

    Update advertising deals **Requires one of these permissions**: ["inventory_edit", "inventory_view"]

    POST /adsApi/v1/update/advertisingDeals

  • Write

    SBUpdate Advertising Deal

    Update advertisingDeal **Requires one of these permissions**: ["advertiser_campaign_edit", "advertiser_campaign_view"]

    POST /adsApi/v1/update/advertisingDeals/sb

Branded Keywords Pricings

  • Write

    SBCreate Branded Keywords Pricing

    Create brandedKeywords pricing **Requires one of these permissions**: ["advertiser_campaign_edit", "advertiser_campaign_view"]

    POST /adsApi/v1/create/brandedKeywordsPricings/sb

Campaigns

  • Read

    Query Campaign

    Query campaign **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["advertiser_campaign_edit", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view"]

    POST /adsApi/v1/query/campaigns

  • Write

    Create Campaign

    Create campaigns **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]

    POST /adsApi/v1/create/campaigns

  • Write

    Update Campaign

    Update campaign **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Note:** For Amazon DSP, `state` supports only ENABLED and PAUSED; ARCHIVED is not a valid state for DSP campaigns. **Requires one of these permissions**: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]

    POST /adsApi/v1/update/campaigns

  • Destructive

    Delete Campaign

    Delete campaigns **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["advertiser_campaign_edit"]

    POST /adsApi/v1/delete/campaigns

Deal Advertiser Access Entries

  • Read

    Query Deal Advertiser Access Entry

    Query advertiser entries for a deal advertiser access record **Requires one of these permissions**: ["inventory_edit", "inventory_view"]

    POST /adsApi/v1/query/dealAdvertiserAccessEntries

  • Write

    Create Deal Advertiser Access Entry

    Add advertisers to a deal advertiser access list **Requires one of these permissions**: ["inventory_edit"]

    POST /adsApi/v1/create/dealAdvertiserAccessEntries

  • Destructive

    Delete Deal Advertiser Access Entry

    Remove advertisers from a deal advertiser access list **Requires one of these permissions**: ["inventory_edit"]

    POST /adsApi/v1/delete/dealAdvertiserAccessEntries

Deal Advertiser Accesses

  • Read

    Retrieve Deal Advertiser Access

    Retrieve a deal advertiser access record by ID **Requires one of these permissions**: ["inventory_edit", "inventory_view"]

    POST /adsApi/v1/retrieve/dealAdvertiserAccesses

  • Write

    Create Deal Advertiser Access

    Create a deal advertiser access record with a strategy (ALLOW or BLOCK) **Requires one of these permissions**: ["inventory_edit"]

    POST /adsApi/v1/create/dealAdvertiserAccesses

  • Destructive

    Delete Deal Advertiser Access

    Delete a deal advertiser access record and all associated entries **Requires one of these permissions**: ["inventory_edit"]

    POST /adsApi/v1/delete/dealAdvertiserAccesses

Deal Preferences

  • Read

    List Deal Preference

    Lists deal preferences for a DSP advertiser account. **Requires one of these permissions**: ["campaign_view", "campaign_edit"]

    GET /adsApi/v1/dealPreferences

  • Write

    Create Deal Preference

    Creates one or more deal preferences for a DSP advertiser account. **Requires one of these permissions**: ["campaign_edit"]

    POST /adsApi/v1/create/dealPreferences

Events

  • Write

    Create Event

    Create Event Data **Requires one of these permissions**: ["event_manager_view", "event_manager_edit", "MasterAccount_Manager"]

    POST /adsApi/v1/create/events

Geo Locations

  • Write

    Create Geo Location

    Create geo location targeting definitions. Supports smart locations, which target users based on their percentile rank within a Smart Location Index, and radius locations, which target users within a specified distance of an address or coordinate. Note: radius locations are currently in beta. **Requires one of these permissions**: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit", "MasterAccount_Manager"]

    POST /adsApi/v1/create/geoLocations

Keyword Reservation Validations

  • Write

    SBCreate Keyword Reservation Validation

    Validate keyword reservation **Requires one of these permissions**: ["advertiser_campaign_edit", "advertiser_campaign_view"]

    POST /adsApi/v1/create/keywordReservationValidations/sb

Location Indexes

  • Read

    List Location Index

    List all Smart Location Indexes for the authenticated advertiser. Returns a paginated collection of indexes including their current processing status. Use the nextToken from the response to retrieve subsequent pages. **Requires one of these permissions**: ["advertiser_campaign_edit", "MasterAccount_Viewer", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view", "campaign_edit", "dsp_campaign_edit", "MasterAccount_Manager"]

    GET /adsApi/v1/locationIndexes

  • Read

    Retrieve Location Index

    Retrieve one or more Smart Location Indexes by ID. Returns the current metadata and processing status for each requested index. An index with status PENDING is still being processed and is not yet available for use in smart location targeting. **Requires one of these permissions**: ["advertiser_campaign_edit", "MasterAccount_Viewer", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view", "campaign_edit", "dsp_campaign_edit", "MasterAccount_Manager"]

    POST /adsApi/v1/retrieve/locationIndexes

  • Write

    Create Location Index

    Create a Smart Location Index. A Smart Location Index is a named dataset that maps postal codes to index values representing relative audience quality or sales potential for a given advertiser. Index data is processed asynchronously; the index status will transition from PENDING to ENABLED once processing is complete. **Requires one of these permissions**: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit", "MasterAccount_Manager"]

    POST /adsApi/v1/create/locationIndexes

  • Write

    Update Location Index

    Update the data for an existing Smart Location Index. Replaces the index's postal code values with the provided dataset. The update is processed asynchronously; the index status will return to PENDING until the new data has been fully processed. **Requires one of these permissions**: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit", "MasterAccount_Manager"]

    POST /adsApi/v1/update/locationIndexes

Manager Accounts

  • Read

    Query Manager Account

    List manager accounts **Requires one of these permissions**: []

    POST /adsApi/v1/query/managerAccounts

  • Write

    Create Manager Account

    Create manager accounts **Requires one of these permissions**: []

    POST /adsApi/v1/create/managerAccounts

  • Write

    Update Manager Account

    Update manager accounts **Requires one of these permissions**: []

    POST /adsApi/v1/update/managerAccounts

Recommendations

  • Read

    Query Recommendation

    Fetch full recommendations for a given advertiser and product. **Requires one of these permissions**: ["adv_billing_view", "nemo_transactions_edit", "user_edit", "reports_view", "view_performance_dashboard", "campaign_confidential_data_view", "inventory_confidential_data_view", "nemo_report_view", "brand_posts_view", "account_edit", "amazon_stores_view", "advertiser_campaign_view", "campaign_edit", "MasterAccount_Manager", "user_view", "nemo_transactions_view", "MasterAccount_Viewer", "brand_posts_admin", "adv_billing_edit", "reports_edit", "ManagerAccount_Dev", "advertiser_campaign_edit", "account_view", "amazon_stores_edit", "brand_posts_edit", "campaign_view", "nemo_report_edit"]

    POST /adsApi/v1/query/recommendations

  • Read

    List Recommendation

    List recommendations for a given advertiser. **Requires one of these permissions**: ["adv_billing_view", "nemo_transactions_edit", "user_edit", "reports_view", "view_performance_dashboard", "campaign_confidential_data_view", "inventory_confidential_data_view", "nemo_report_view", "brand_posts_view", "account_edit", "amazon_stores_view", "advertiser_campaign_view", "campaign_edit", "MasterAccount_Manager", "user_view", "nemo_transactions_view", "MasterAccount_Viewer", "brand_posts_admin", "adv_billing_edit", "reports_edit", "ManagerAccount_Dev", "advertiser_campaign_edit", "account_view", "amazon_stores_edit", "brand_posts_edit", "campaign_view", "nemo_report_edit"]

    GET /adsApi/v1/recommendations

  • Write

    SBCreate Recommendation

    Create recommendations **Requires one of these permissions**: ["advertiser_campaign_view"]

    POST /adsApi/v1/create/recommendations/sb

Reports

  • Read

    Ads Apiv1Retrieve Report

    Retrieve a report by ID **Requires one of these permissions**: []

    POST /adsApi/v1/retrieve/reports

  • Write

    Ads Apiv1Create Report

    Create a report **Requires one of these permissions**: ["ManagerAccount_Dev", "advertiser_campaign_edit", "nemo_report_view", "MasterAccount_Viewer", "MA_ReadOnly", "advertiser_campaign_view", "reports_edit", "MasterAccount_Manager", "nemo_report_edit", "view_performance_dashboard"]

    POST /adsApi/v1/create/reports

  • Destructive

    Ads Apiv1Delete Report

    Delete a report by ID **Requires one of these permissions**: []

    POST /adsApi/v1/delete/reports

Reserved Target Pricings

  • Write

    SBAds Apiv1Create Reserved Target Pricing

    Create reservedTarget pricing **Requires one of these permissions**: ["advertiser_campaign_edit", "advertiser_campaign_view"]

    POST /adsApi/v1/create/reservedTargetPricings/sb

Stream Subscriptions

  • Write

    Ads Apiv1Create Stream Subscription

    Create a new subscription\nNote: trailing slash in request uri is not allowed **Requires one of these permissions**: ["ManagerAccount_Dev", "advertiser_campaign_edit", "nemo_report_view", "MasterAccount_Viewer", "MA_ReadOnly", "advertiser_campaign_view", "reports_edit", "view_performance_dashboard", "MasterAccount_Manager", "nemo_report_edit"]

    POST /adsApi/v1/create/streamSubscriptions

  • Write

    Ads Apiv1Delete Stream Subscription

    Archive an existing subscription Note: trailing slash in request uri is not allowed **Requires one of these permissions**: ["ManagerAccount_Dev", "advertiser_campaign_edit", "nemo_report_view", "MasterAccount_Viewer", "MA_ReadOnly", "advertiser_campaign_view", "reports_edit", "view_performance_dashboard", "MasterAccount_Manager", "nemo_report_edit"]

    POST /adsApi/v1/delete/streamSubscriptions

  • Write

    Ads Apiv1Query Stream Subscription

    Query subscriptions Note: trailing slash in request uri is not allowed **Requires one of these permissions**: ["ManagerAccount_Dev", "advertiser_campaign_edit", "nemo_report_view", "MasterAccount_Viewer", "MA_ReadOnly", "advertiser_campaign_view", "reports_edit", "view_performance_dashboard", "MasterAccount_Manager", "nemo_report_edit"]

    POST /adsApi/v1/query/streamSubscriptions

  • Write

    Ads Apiv1Retrieve Stream Subscription

    Fetch a specific subscription by Id Note: trailing slash in request uri is not allowed **Requires one of these permissions**: ["ManagerAccount_Dev", "advertiser_campaign_edit", "nemo_report_view", "MasterAccount_Viewer", "MA_ReadOnly", "advertiser_campaign_view", "reports_edit", "view_performance_dashboard", "MasterAccount_Manager", "nemo_report_edit"]

    POST /adsApi/v1/retrieve/streamSubscriptions

Supplier Ad Product Prices

  • Write

    Create Supplier Ad Product Price

    Create supplier ad product price **Requires one of these permissions**: ["inventory_view"]

    POST /adsApi/v1/create/supplierAdProductPrices

Supplier Proposals

  • Read

    Query Supplier Proposal

    Query supplier proposal **Requires one of these permissions**: ["inventory_view"]

    POST /adsApi/v1/query/supplierProposals

  • Write

    Create Supplier Proposal

    Create supplier proposal **Requires one of these permissions**: ["inventory_edit"]

    POST /adsApi/v1/create/supplierProposals

  • Write

    Update Supplier Proposal

    Update supplier proposal **Requires one of these permissions**: ["inventory_edit"]

    POST /adsApi/v1/update/supplierProposals

Supplier Proposed Deal Forecasts

  • Write

    Create Supplier Proposed Deal Forecast

    Create supplier proposed deal forecast **Requires one of these permissions**: ["inventory_edit"]

    POST /adsApi/v1/create/supplierProposedDealForecasts

Supplier Proposed Deal Revisions

  • Write

    Create Supplier Proposed Deal Revision

    Create supplier proposed deal revision **Requires one of these permissions**: ["inventory_edit"]

    POST /adsApi/v1/create/supplierProposedDealRevisions

  • Write

    Update Supplier Proposed Deal Revision

    Update supplier proposed deal revision **Requires one of these permissions**: ["inventory_edit"]

    POST /adsApi/v1/update/supplierProposedDealRevisions

Supplier Proposed Deals

  • Read

    Query Supplier Proposed Deal

    Query supplier proposed deals **Requires one of these permissions**: ["inventory_view"]

    POST /adsApi/v1/query/supplierProposedDeals

  • Write

    Create Supplier Proposed Deal

    Create supplier proposed deal **Requires one of these permissions**: ["inventory_edit"]

    POST /adsApi/v1/create/supplierProposedDeals

  • Write

    Update Supplier Proposed Deal

    Update supplier proposed deal **Requires one of these permissions**: ["inventory_edit"]

    POST /adsApi/v1/update/supplierProposedDeals

Targets

  • Read

    Query Target

    List target **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["advertiser_campaign_edit", "dsp_campaign_view", "campaign_view", "advertiser_campaign_view", "campaign_edit", "dsp_campaign_edit"]

    POST /adsApi/v1/query/targets

  • Write

    Create Target

    Create target **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]

    POST /adsApi/v1/create/targets

  • Write

    Update Target

    Update target **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Note:** For Amazon DSP, `state` supports only ENABLED and ARCHIVED; PAUSED is not a valid state for DSP targets. **Requires one of these permissions**: ["advertiser_campaign_edit"]

    POST /adsApi/v1/update/targets

  • Destructive

    Delete Target

    Delete target **Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits. **Requires one of these permissions**: ["advertiser_campaign_edit", "campaign_edit", "dsp_campaign_edit"]

    POST /adsApi/v1/delete/targets

Deal Performances

  • Read

    List Deal Performance

    Retrieve performance metrics for each specified deal. **Requires one of these permissions**: ["inventory_view"]

    GET /adsApi/v1/dealPerformances

Brand Store Edition Publish Versions

  • Read

    Query Brand Store Edition Publish Version

    Query store edition publish versions **Requires one of these permissions**: ["amazon_stores_edit","amazon_stores_view"]

    POST /adsApi/v1/query/brandStoreEditionPublishVersions

  • Write

    Update Brand Store Edition Publish Version

    Update store edition publish versions **Requires one of these permissions**: ["amazon_stores_edit"]

    POST /adsApi/v1/update/brandStoreEditionPublishVersions

Brand Store Pages

  • Read

    Query Brand Store Page

    Retrieve brand store page content **Requires one of these permissions**: ["amazon_stores_edit","amazon_stores_view"]

    POST /adsApi/v1/query/brandStorePages

Brand Stores

  • Read

    Query Brand Store

    Query brand store content **Requires one of these permissions**: ["advertiser_campaign_edit", "creatives_view", "account_view", "creatives_edit", "account_edit", "campaign_view", "advertiser_campaign_view", "campaign_edit"]

    POST /adsApi/v1/query/brandStores

Deal Availses

  • Read

    Query Deal Avails

    Query deal avails by advertising deal ID. Returns avails records aggregated by selected attributes over the last 7 days, sorted by eligible avails descending. **Requires one of these permissions**: ["inventory_view"]

    POST /adsApi/v1/query/dealAvailses

Deal Planning Metricses

  • Read

    Query Deal Planning Metrics

    Query deal planning metrics for specified deals, with optional metric range filters and sort. **Requires one of these permissions**: ["inventory_view"]

    POST /adsApi/v1/query/dealPlanningMetricses

Label Object Associations

  • Read

    Query Label Object Association

    Query label-to-object associations with filters. **Requires one of these permissions**: ["campaign_view", "campaign_edit"]

    POST /adsApi/v1/query/labelObjectAssociations

Labels

  • Read

    Query Label

    Query labels with filters. Returns labels that have associations of the specified object type and are visible to the caller's entity. **Requires one of these permissions**: ["campaign_view", "campaign_edit"]

    POST /adsApi/v1/query/labels

Publishers

  • Read

    Query Publisher

    Query publishers. A publisher is a business entity that operates the apps, sites, or video streams where ads are displayed. Use this API to search publishers by ID or name, for example to understand and compare where your ads run. **Requires one of these permissions**: ["inventory_view"]

    POST /adsApi/v1/query/publishers

Recommendation Types

  • Write

    SBQuery Recommendation Type

    Query RecommendationTypes **Requires one of these permissions**: ["advertiser_campaign_view"]

    POST /adsApi/v1/query/recommendationTypes/sb

Sellers

  • Read

    Query Seller

    Query sellers. A seller is a business entity that has the rights to sell a publisher's advertising inventory and holds accounts with suppliers that send that inventory to Amazon DSP. Use this API to search sellers by ID or name, for example to identify a seller when creating a deal or commitment. **Requires one of these permissions**: ["inventory_view"]

    POST /adsApi/v1/query/sellers

Selling Accounts

  • Read

    Query Selling Account

    List selling accounts **Requires one of these permissions**: []

    POST /adsApi/v1/query/sellingAccounts

Supplier Ad Products

  • Read

    Query Supplier Ad Product

    Query supplier ad products **Requires one of these permissions**: ["inventory_view"]

    POST /adsApi/v1/query/supplierAdProducts

Supplier Proposal Destinations

  • Read

    Query Supplier Proposal Destination

    Query supplier proposal destinations **Requires one of these permissions**: ["inventory_view"]

    POST /adsApi/v1/query/supplierProposalDestinations

Supplier Proposed Deal Historical Versions

  • Read

    Query Supplier Proposed Deal Historical Version

    Query supplier proposed deal historical versions **Requires one of these permissions**: ["inventory_view"]

    POST /adsApi/v1/query/supplierProposedDealHistoricalVersions

Supplier Publishers

  • Read

    Query Supplier Publisher

    Query supplier publishers **Requires one of these permissions**: ["inventory_view"]

    POST /adsApi/v1/query/supplierPublishers

Supplier Target Items

  • Read

    Query Supplier Target Item

    Fetch supplier target items **Requires one of these permissions**: ["inventory_view"]

    POST /adsApi/v1/query/supplierTargetItems

Suppliers

  • Read

    Query Supplier

    Query suppliers. A supplier is a business entity that sends advertising inventory to Amazon DSP, either through direct publisher relationships or as an intermediary such as a supply-side platform (SSP). Use this API to search suppliers by ID or name, or to find the suppliers that can serve a given inventory type or delivery channel in the open auction. **Requires one of these permissions**: ["inventory_view"]

    POST /adsApi/v1/query/suppliers

Campaign Forecasts

  • Write

    DSPRetrieve Campaign Forecast

    Retrieve campaign forecast **Requires one of these permissions**: ["campaign_view", "advertiser_campaign_view"]

    POST /adsApi/v1/retrieve/campaignForecasts/dsp

Commitment Spends

  • Read

    Retrieve Commitment Spend

    Retrieve commitment spend **Requires one of these permissions**: []

    POST /adsApi/v1/retrieve/commitmentSpends

Get started

  1. Open Space settings → Connections and search for Amazon Ads.
  2. Connect your account and add the connection to the Space.
  3. Ask for what you need in any thread in that Space.

See How connections work for access and permissions, or browse all integrations.