Jump to Content
apiBuy with Prime | Developer Documentation
DocumentationAnnouncements
Buy with Prime | Developer DocumentationLog Inapi
Documentation
Log In
DocumentationAnnouncements

GET STARTED

  • About the Buy with Prime API
  • Authenticate to the Buy with Prime API
  • Call the Buy with Prime API
  • Terminology

DEVELOPER GUIDES

  • Integrate with Buy with Prime
  • Manage Shopper Identity
    • Use Amazon Pay for Shopper Identity
    • Use Login with Amazon for Shopper Identity
      • Integrate Login with Amazon with Your Site
  • Test in a Sandbox Environment
    • Change the State of an Order Delivery in the Sandbox
    • Change the State of a Return in the Sandbox
  • Create and Manage Catalogs
    • Upload a Catalog
    • Get the Result of a Catalog Upload
    • Query a Catalog
    • Best Practices for Catalogs
    • Troubleshoot Catalog Errors
  • Create Delivery Previews
    • Create a Delivery Preview for a Product Detail Page
    • Create a Delivery Preview for Checkout
    • Use a Delivery Offer to Create an Order
    • Troubleshoot Delivery Preview Errors
  • Create and Manage Orders
    • Create a Buy with Prime Order
    • Update a Buy with Prime Order
    • Query a Buy with Prime Order
    • Best Practices for Orders
    • Troubleshoot Order Errors
  • Synchronize Refunds
    • Steps to Process Refunds
    • Get Refund Details
    • Update Refund Details
    • Troubleshoot Refund Errors
  • Process Returns
    • Steps to Process Returns
    • Get Reversal Offers
    • Get Return Details
    • Troubleshoot Return Errors
  • Retrieve and Delete Shopper Data
    • Retrieve a Shopper's Personal Data
    • Delete a Shopper's Personal Data
    • Cancel a Data Deletion Request
    • Query Privacy Requests
  • Analyze Your Buy with Prime Metrics
    • Send User Events for Buy with Prime
    • Analytics Event Schema
  • Subscribe to Events
    • Steps to Subscribe to Buy with Prime Events
    • Create and Delete Event Subscriptions
    • Query Event Subscriptions
    • Event Types
      • BUYABILITY_CHANGED
      • DELIVERY_CANCELLED
      • DELIVERY_COMPLETED
      • DELIVERY_IN_TRANSIT
      • INVENTORY_CHANGED
      • ITEM_CANCELLED
      • ITEM_DELIVERED
      • ITEM_IN_TRANSIT
      • PERSONAL_DATA_DELETION_TASK_COMPLETED
      • PERSONAL_DATA_DELETION_TASK_FAILED
      • PERSONAL_DATA_RETRIEVAL_TASK_COMPLETED
      • PERSONAL_DATA_RETRIEVAL_TASK_FAILED
      • REFUND_REQUESTED
      • RETURN_COMPLETED
      • RETURN_DELIVERY_COMPLETED
      • RETURN_DELIVERY_FAILED
      • RETURN_DELIVERY_IN_TRANSIT
      • RETURN_ITEM_GRADED
      • RETURN_STARTED
    • Troubleshoot Events

Salesforce Integration

  • Understand Buy with Prime on Salesforce Commerce Cloud
  • Buy with Prime Cartridge for Salesforce Commerce Cloud
    • Install the Buy with Prime Cartridge
    • Configure the Buy with Prime Cartridge
    • Update Your Product Catalog to Offer Products That Are Eligible for Buy with Prime
    • Integrate the Buy with Prime Cartridge into your Storefront
    • Offer Exclusive Promotions to Prime Members by Using the Buy with Prime Cartridge
    • Update Subresource Integrity Hash Values for Scripts in the Buy with Prime Cartridge
    • Install and Configure the Amazon Pay Cartridge
  • Salesforce OMS Package for Buy with Prime
    • Configure the Salesforce OMS and Provision a B2C Commerce Connection
    • Install and Configure the Connector Cartridge for Buy with Prime
    • Create Your Product and Delivery Method for Buy with Prime
  • Steps for Installing the Salesforce OMS Package for Buy with Prime
    • Install the Salesforce OMS Package for Buy with Prime
    • Understand Permission Sets in the OMS Package for Buy with Prime
    • Manage Access to the Custom Fields for Buy with Prime
    • Configure the Permission Set for the Order Management B2C Service
  • Configure the Salesforce OMS Package for Buy with Prime
    • Create Your Salesforce Connected App for Buy with Prime
    • Add a Sales Channel in the Salesforce OMS Package for Buy with Prime
    • Map Your Buy with Prime Data to Your Salesforce Objects
    • Configure the Event Consumer SDK for Buy with Prime
    • Configure the Package Logs in the OMS Package
    • Associate an Order with a Sales Channel Using Salesforce Flow Builder

API REFERENCE

  • Catalog
    • Mutations
      • createCatalogFeed
      • createUploadLink
    • Queries
      • catalogFeed
      • downloadLink
      • inventoryItem
      • mappingProduct
    • Objects
      • AmazonProductIdentifierInput
      • Boolean
      • Buyability
      • CatalogFeed
      • CatalogFeedConfigurationInput
      • CatalogFeedDataProviderInput
      • CatalogFeedResult
      • CatalogFeedResultReport
      • CreateCatalogFeedInput
      • CreateCatalogFeedResponse
      • Decimal
      • DownloadLink
      • ExternalItemIdentifier
      • ExternalProductIdentifier
      • FeaturedImage
      • ID
      • ImpactSummary
      • InventoryItem
      • Issue
      • ItemIdentifierInput
      • LocalizedMessage
      • Long
      • MappingProduct
      • MappingProductIdentifierInput
      • MskuItemIdentifier
      • MskuProductIdentifier
      • Quantity
      • ReactionSummary
      • Signal
      • SignalMessage
      • SkuItemIdentifier
      • SkuProductIdentifier
      • String
      • UploadFileExtension
      • UploadLink
      • UploadLinkInput
      • UploadedFile
      • UploadedFileInput
  • Delivery Preview
    • Queries
      • deliveryPreview
      • shopperBwPEligibility
    • Objects
      • APayCheckoutSessionId
      • AmazonProductIdentifierInput
      • Amount
      • AmountInput
      • Decimal
      • DeliveryCharge
      • DeliveryDateRange
      • DeliveryGroup
      • DeliveryItem
      • DeliveryItemInput
      • DeliveryLocationInput
      • DeliveryMessage
      • DeliveryOffer
      • DeliveryPolicy
      • DeliveryPreview
      • DeliveryPreviewInput
      • DeliveryPreviewTermsInput
      • DeliveryPrice
      • DeliveryRollupCharge
      • DeliveryRollupPrice
      • ID
      • IdPTokenType
      • IdentityProvider
      • IdentityTokenInput
      • ItemDeliveryMessage
      • ItemIdentifier
      • ItemIdentifierInput
      • LWAAccessToken
      • Money
      • Quantity
      • QuantityInput
      • ShippingAddressInput
      • ShopperBwPEligibility
      • String
  • Order
    • Mutations
      • createOrder
      • updateOrder
    • Queries
      • order
    • Objects
      • APayCheckoutSessionId
      • AddressInput
      • Alias
      • AliasInput
      • AmazonProductIdentifierInput
      • Amount
      • AmountInput
      • Association
      • AssociationInput
      • Boolean
      • BrowserFingerprintInput
      • CanceledFor
      • CanceledOrderLineItem
      • CancellationDetails
      • Cancellations
      • ClientDetailsInput
      • ContactInput
      • CreateOrderInput
      • CreateOrderResponse
      • Customer
      • CustomerInput
      • Decimal
      • DeliveryInformation
      • DeliveryInformationDetails
      • DeliveryInformationDetailsAliasInput
      • DeliveryInformationDetailsFor
      • DeliveryInformationSummary
      • DeliveryItem
      • DeliveryMessage
      • DeliveryMessageInput
      • DeliveryOfferDetails
      • DeliveryOfferDetailsInput
      • DeliveryOfferInfo
      • DeliveryOfferInput
      • DeliveryOfferProviderInput
      • DeliveryOfferSummary
      • DeliveryOfferSummaryInput
      • DeliveryOfferSummaryProviderInput
      • DeliveryPolicy
      • DiscountAllocationDetails
      • DiscountAllocationDetailsInput
      • DiscountAllocationInput
      • DiscountAllocations
      • DiscountAllocationsSummary
      • DiscountAllocationsSummaryInput
      • EmailDataInput
      • ID
      • ISODateRange
      • IdPTokenType
      • IdentityProvider
      • IdentityTokenInput
      • Interval
      • IpFingerprintInput
      • ItemDeliveryMessage
      • ItemIdentifier
      • ItemIdentifierInput
      • LWAAccessToken
      • LineItem
      • LineItemAssociation
      • LineItemAssociationInput
      • LineItemIdentifierInput
      • LineItemInput
      • Money
      • MoneyInput
      • Order
      • OrderExecutionStateInput
      • OrderIdentifierInput
      • OrderLineItemAmount
      • OrderLink
      • OrderLinkInput
      • OrderLinkTypeInput
      • OrderMetadata
      • OrderTotalSummary
      • OrderTotalSummaryInput
      • Payer
      • PayerInput
      • PaymentDetails
      • PaymentDetailsInput
      • PaymentMethod
      • PaymentMethodInput
      • PaymentMethodTypeInput
      • PaymentStateInput
      • PaymentSummary
      • PaymentSummaryInput
      • Payments
      • PaymentsInput
      • Price
      • PriceInput
      • PurchasedItem
      • PurchasedItemInput
      • Quantity
      • QuantityInput
      • Recipient
      • RecipientInput
      • RefundDetails
      • RefundDetailsInput
      • RefundFor
      • RefundForInput
      • RefundInput
      • RefundStateInput
      • RefundSummary
      • RefundSummaryInput
      • RefundTotal
      • RefundTotalInput
      • RefundedOrderLineItem
      • RefundedOrderLineItemInput
      • Refunds
      • ReturnDetails
      • ReturnFor
      • ReturnOrderLineItem
      • Returns
      • RollupCharge
      • RollupChargeInput
      • RollupChargeTypeInput
      • ShippingAddress
      • ShopperContact
      • StoreFingerprintInput
      • String
      • TaxInput
      • TaxSummary
      • TaxSummaryInput
      • Taxes
      • TrackingDetails
      • UpdateOrderInput
      • UpdateOrderResponse
      • VariantSelection
      • VariantSelectionInput
  • Privacy
    • Mutations
      • cancelPersonalDataDeletionTask
      • startPersonalDataDeletionTask
      • startPersonalDataRetrievalTask
    • Queries
      • personalDataDeletionTask
      • personalDataRetrievalTask
    • Objects
      • CancelPersonalDataDeletionTaskResponse
      • ClientToken
      • DataSubject
      • DataSubjectInput
      • DataSubjectTypeInput
      • ID
      • Int
      • PersonalDataDeletionTask
      • PersonalDataRetrievalTask
      • PersonalDataTaskError
      • StartPersonalDataDeletionTaskInput
      • StartPersonalDataDeletionTaskResponse
      • StartPersonalDataRetrievalTaskInput
      • StartPersonalDataRetrievalTaskResponse
      • String
  • Returns
    • Queries
      • generateReversalOffers
    • Objects
      • AmazonProductIdentifierInput
      • ID
      • ReversalItem
      • ReversalItemIdentifier
      • ReversalItemIdentifierInput
      • ReversalItemInput
      • ReversalOfferGroup
      • ReversalOfferGroupSummary
      • ReversalOffers
      • ReversalOffersInput
      • String
  • Analytics
    • Mutations
      • sendUserEvents
    • Objects
      • AdditionalPropertiesInput
      • ClientType
      • PropertyTuple
      • SendUserEventInput
      • SendUserEventOutput
      • String
      • UserEvent
  • Events
    • Mutations
      • createEventSubscription
      • deleteEventSubscription
    • Queries
      • eventSubscription
      • eventSubscriptions
    • Objects
      • Boolean
      • CreateEventSubscriptionInput
      • CreateEventSubscriptionResponse
      • DeleteEventSubscriptionResponse
      • DestinationData
      • DestinationInput
      • EventBridgeData
      • EventBridgeDataInput
      • EventSubscription
      • EventSubscriptionConnection
      • EventSubscriptionDetails
      • EventSubscriptionEdge
      • EventSubscriptionId
      • ID
      • Int
      • PageInfo
      • String
      • partnerEventSource
  • Sandbox
    • Mutations
      • updateOrderDeliveryInformation
      • updateOrderReturns
    • Objects
      • Alias
      • AliasInput
      • Amount
      • AmountInput
      • Association
      • Boolean
      • CanceledFor
      • CanceledOrderLineItem
      • CancellationDetails
      • Cancellations
      • Customer
      • Decimal
      • DeliveryInformation
      • DeliveryInformationDetails
      • DeliveryInformationDetailsFor
      • DeliveryInformationDetailsForInput
      • DeliveryInformationDetailsInput
      • DeliveryInformationDetailsReasonInput
      • DeliveryInformationDetailsStateInput
      • DeliveryInformationStateInput
      • DeliveryInformationSummary
      • DeliveryItem
      • DeliveryMessage
      • DeliveryOfferDetails
      • DeliveryOfferInfo
      • DeliveryOfferSummary
      • DeliveryPolicy
      • DiscountAllocationDetails
      • DiscountAllocations
      • DiscountAllocationsSummary
      • ID
      • ISODateRange
      • Interval
      • ItemDeliveryMessage
      • ItemIdentifier
      • LineItem
      • LineItemAssociation
      • LineItemIdentifierInput
      • Money
      • Order
      • OrderLineItemAmount
      • OrderLineItemAmountInput
      • OrderLink
      • OrderMetadata
      • OrderTotalSummary
      • Payer
      • PaymentDetails
      • PaymentMethod
      • PaymentSummary
      • Payments
      • Price
      • PurchasedItem
      • Quantity
      • Recipient
      • RefundDetails
      • RefundFor
      • RefundSummary
      • RefundTotal
      • RefundedOrderLineItem
      • Refunds
      • ReturnDetails
      • ReturnDetailsInput
      • ReturnDetailsStateInputV20240101
      • ReturnFor
      • ReturnOrderLineItem
      • Returns
      • RollupCharge
      • ShippingAddress
      • ShopperContact
      • String
      • TaxSummary
      • Taxes
      • TrackingDetails
      • UpdateOrderDeliveryInformationInput
      • UpdateOrderDeliveryInformationResponse
      • UpdateOrderReturnsInput
      • UpdateOrderReturnsResponse
      • VariantSelection

Mutations

Version 2024-01-01

📘

Important

The Buy with Prime API is offered as a preview and might change as we receive feedback and iterate on the interfaces. We are sharing this early documentation to help you learn about the Buy with Prime API as we write and iterate on the content.

Mutations

Mutations related mutations for Buy with Prime API interfaces.

  • cancelPersonalDataDeletionTask
  • startPersonalDataDeletionTask
  • startPersonalDataRetrievalTask

Updated 4 months ago


  • Table of Contents
    • Mutations