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
  • Changelog for the Buy with Prime API v2024-11-01
  • Architectural Overview of Ecommerce and Fulfillment Services

DEVELOPER GUIDES

  • Integrate with Buy with Prime
  • Manage Shopper Identity
    • Use Amazon Pay for Shopper Identity
    • Use Login with Amazon for Shopper Identity
      • LWA Authentication Flow
      • Set up an LWA Security Profile
      • Integrate with LWA by Using an LWA SDK
      • Integrate Directly with LWA
      • LWA Integration Tasks
  • Test in a Sandbox Environment
    • Change the State of an Outbound Package in the Sandbox
    • Change the State of a Return Package in the Sandbox
    • Troubleshoot Sandbox Errors
  • Create and Manage Catalogs
    • Create and Manage Products in a Catalog
    • Create and Manage Product Variations
    • Create and Manage Purchase Groups
    • 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
    • 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
    • Cancel a Buy with Prime Order
    • Best Practices for Orders
    • Troubleshoot Order Errors
  • Track Packages
    • Troubleshoot Package Tracking
  • Synchronize Refunds
    • Steps to Process Refunds
    • Add an External Refund
    • Update Refund Details
    • Get Refund Details
    • Troubleshoot Refund Errors
  • Process Returns
    • Steps to Process Returns
    • Add an External Return
    • Update Return Details
    • 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
  • Get Analytics Reports
    • Get User Engagement Data
      • User Event Schema
    • View Buy with Prime Fees Charged For Each Order
    • Troubleshoot Analytics Errors
  • Subscribe to Events
    • Steps to Subscribe to Buy with Prime Events
    • Create and Delete Event Subscriptions
    • Query Event Subscriptions
    • Event Types
      • BUYABILITY_CHANGED
      • INVENTORY_CHANGED
      • PACKAGE_DELIVERED
      • PACKAGE_DELIVERY_CANCELLED
      • PACKAGE_DELIVERY_IN_TRANSIT
      • PACKAGE_TRACKER_MILESTONE_CHANGED
      • 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_ITEM_GRADED
      • RETURN_PACKAGE_DELIVERED
      • RETURN_PACKAGE_DELIVERY_FAILED
      • RETURN_PACKAGE_IN_TRANSIT
      • RETURN_STARTED
    • Troubleshoot Events

SALESFORCE INTEGRATION

  • Understand Buy with Prime on Salesforce Commerce Cloud
  • Buy with Prime Cartridge for Salesforce Commerce Cloud
  • Salesforce OMS Package for Buy with Prime
  • Version 0.13.0 Release Notes for the Buy with Prime Cartridge

API Reference

  • Catalog
    • Mutations
      • createCatalogFeed
      • createProduct
      • createPurchaseGroup
      • createUploadLink
      • deleteProduct
      • updateProduct
    • Queries
      • catalogFeed
      • downloadLink
      • inventoryItem
      • product
      • products
    • Objects
      • AmazonSkuProductIdentifier
      • AmazonSkuProductIdentifierInput
      • Amount
      • AmountInput
      • AsinProductIdentifier
      • Boolean
      • BooleanFilter
      • Buyability
      • CatalogFeed
      • CatalogFeedConfigurationInput
      • CatalogFeedDataProviderInput
      • CatalogFeedResult
      • CatalogFeedResultReport
      • CreateCatalogFeedInput
      • CreateCatalogFeedResponse
      • CreateProductInput
      • CreateProductResponse
      • CreatePurchaseGroupInput
      • CreatePurchaseGroupResponse
      • CreateUploadLinkInput
      • CreateUploadLinkResponse
      • Decimal
      • DeleteProductResponse
      • DownloadLink
      • ExternalProductIdentifier
      • FeaturedImage
      • FeaturedImageInput
      • GroupableProduct
      • ID
      • ImpactSummary
      • Int
      • InventoryItem
      • LocalizedDescriptionFieldInput
      • LocalizedDescriptionStringInput
      • LocalizedString
      • LocalizedStringField
      • LocalizedStringFieldInput
      • LocalizedStringInput
      • Long
      • Money
      • MoneyInput
      • Node
      • PageInfo
      • Price
      • PriceInput
      • Product
      • ProductConnection
      • ProductEdge
      • ProductId
      • ProductIdentifierInput
      • ProductMetadata
      • ProductsInputFilter
      • PurchaseGroup
      • PurchaseGroupMember
      • PurchaseGroupMemberConnection
      • PurchaseGroupMemberEdge
      • PurchaseGroupMemberInput
      • PurchaseGroupMembershipInput
      • PurchaseGroupViewMember
      • PurchasedProductView
      • Quantity
      • ReactionSummary
      • RepresentativeProductInput
      • Signal
      • SignalMessage
      • SkuProductIdentifier
      • String
      • StringFilter
      • UpdateProductInput
      • UpdateProductResponse
      • UploadFileType
      • UploadLink
      • UploadedFile
      • UploadedFileInput
      • VariationGroup
      • VariationGroupMember
      • VariationGroupMemberConnection
      • VariationGroupMemberEdge
      • VariationGroupMembershipInput
      • VariationSelection
      • VariationSelectionInput
  • Delivery Preview
    • Queries
      • deliveryPreview
      • shopperBwPEligibility
    • Objects
      • APayCheckoutSessionId
      • AmazonSkuProductIdentifierInput
      • Amount
      • AmountInput
      • Boolean
      • Decimal
      • DeliveryDateRange
      • DeliveryGroup
      • DeliveryLocationInput
      • DeliveryMessage
      • DeliveryOffer
      • DeliveryPolicy
      • DeliveryPreview
      • DeliveryPreviewInput
      • DeliveryPrice
      • DeliveryProduct
      • DeliveryProductInput
      • DeliveryRollupPrice
      • DeliveryTerms
      • DeliveryTermsInput
      • ID
      • IdentityTokenInput
      • LWAAccessToken
      • Money
      • ProductDeliveryMessage
      • ProductIdentifier
      • ProductIdentifierInput
      • ShippingAddressInput
      • ShopperBwPEligibility
      • String
  • Order
    • Mutations
      • cancelOrder
      • createOrder
      • updateOrder
    • Queries
      • offers
      • order
    • Objects
      • APayCheckoutSessionId
      • AddressInput
      • Alias
      • AliasInput
      • AmazonSkuProductIdentifier
      • AmazonSkuProductIdentifierInput
      • Amount
      • AmountInput
      • Boolean
      • BrowserFingerprintInput
      • CancelOrderInput
      • CancelOrderResponse
      • CanceledFor
      • CancellationDetails
      • CancellationReasonInput
      • CancellationRequestDetails
      • CancellationRequestedFor
      • Cancellations
      • ClientDetailsInput
      • ConditionUnits
      • ConditionUnitsInput
      • ContactInput
      • CreateOrderInput
      • CreateOrderResponse
      • Customer
      • CustomerInput
      • Decimal
      • DeliveryDateRange
      • DeliveryLocationInput
      • DeliveryMessage
      • DeliveryMessageInput
      • DeliveryOfferDetails
      • DeliveryOfferDetailsInput
      • DeliveryOfferFor
      • DeliveryOfferForInput
      • DeliveryOfferInfo
      • DeliveryOfferInput
      • DeliveryOfferSummary
      • DeliveryOfferSummaryInput
      • DeliveryPolicy
      • DeliveryPrice
      • DeliveryProduct
      • DeliveryProviderInput
      • DeliveryRollupPrice
      • DeliverySummaryProviderInput
      • DeliveryTerms
      • DeliveryTermsInput
      • DiscountAllocationDetails
      • DiscountAllocationDetailsInput
      • DiscountAllocationInput
      • DiscountAllocations
      • DiscountAllocationsSummary
      • DiscountAllocationsSummaryInput
      • DisplayMessage
      • EmailDataInput
      • ExternalProductIdentifier
      • FeaturedImage
      • FeaturedImageInput
      • Grading
      • GradingConditionInput
      • GradingInput
      • GradingSummary
      • GradingSummaryInput
      • ID
      • IdentityTokenInput
      • Int
      • IpFingerprintInput
      • LWAAccessToken
      • LineItem
      • LineItemIdentifierInput
      • LineItemInput
      • LocalizedString
      • Locator
      • Money
      • MoneyInput
      • Offer
      • OfferConnection
      • OfferEdge
      • OfferLineItemInput
      • OffersInput
      • Order
      • OrderExecutionStateInput
      • OrderIdentifierInput
      • OrderLineItemAmount
      • OrderLineItemAmountInput
      • OrderLink
      • OrderLinkInput
      • OrderLinkTypeInput
      • OrderMetadata
      • OrderRevisionIdentifierInput
      • OrderRevisionInput
      • OrderTotalSummary
      • OrderTotalSummaryInput
      • PackageInformation
      • PackageInformationDetails
      • PackageInformationDetailsFor
      • PackageInformationSummary
      • PackageMilestone
      • PackageMilestoneAddress
      • PackageMilestoneStatus
      • PackageTracker
      • PackageTrackerIdentifier
      • Payer
      • PayerInput
      • PaymentDetails
      • PaymentDetailsInput
      • PaymentMethod
      • PaymentMethodInput
      • PaymentMethodTypeInput
      • PaymentStateInput
      • PaymentSummary
      • PaymentSummaryInput
      • PaymentTerm
      • Payments
      • PaymentsInput
      • ProductDeliveryMessage
      • ProductId
      • ProductIdentifier
      • ProductIdentifierInput
      • PurchaseGroupViewMember
      • PurchaseGroupViewMemberInput
      • PurchasedProductView
      • PurchasedProductViewInput
      • QuantityInput
      • Recipient
      • RecipientInput
      • RefundDetails
      • RefundDetailsInput
      • RefundFor
      • RefundForInput
      • RefundInput
      • RefundRequestReasonInput
      • RefundStateInput
      • RefundStatusReasonInput
      • RefundSummary
      • RefundSummaryInput
      • RefundTerm
      • RefundTotal
      • RefundTotalInput
      • RefundedOrderLineItemInput
      • Refunds
      • ReturnDeliveryDetails
      • ReturnDeliveryDisplayMessage
      • ReturnDeliveryGroup
      • ReturnDeliveryOffer
      • ReturnDeliveryOfferDetails
      • ReturnDeliveryTerm
      • ReturnDetails
      • ReturnDetailsInput
      • ReturnFor
      • ReturnForInput
      • ReturnIdentifierInput
      • ReturnLabel
      • ReturnLineItem
      • ReturnLineItemAmount
      • ReturnLineItemAmountInput
      • ReturnLineItemIdentifierInput
      • ReturnLineItemInput
      • ReturnPackageDetails
      • ReturnReason
      • ReturnReasonTerm
      • ReturnReasonTermInput
      • ReturnStateInput
      • Returns
      • ReturnsInput
      • ReversalOfferDetails
      • ReversalOfferInfo
      • ReversalOfferSummary
      • ReversalWindow
      • RollupCharge
      • RollupChargeInput
      • RollupChargeTypeInput
      • ShippingAddress
      • ShippingAddressInput
      • ShopperContact
      • SkuProductIdentifier
      • String
      • TaxInput
      • TaxSummary
      • TaxSummaryInput
      • Taxes
      • TrackingDetails
      • UpdateLineItemInput
      • UpdateOrderInput
      • UpdateOrderResponse
      • UpdatePackageInformationDetailsInput
      • UpdatePackageInformationInput
      • VariationSelection
      • VariationSelectionInput
  • Returns
    • Mutations
      • createReturn
      • updateReturn
    • Queries
      • return
      • reversalOffers
    • Objects
      • Alias
      • AliasInput
      • AmazonProductIdentifierInput
      • AmazonSkuProductIdentifier
      • Amount
      • AmountInput
      • Boolean
      • CanceledFor
      • CancellationDetails
      • Cancellations
      • ConditionUnits
      • ConditionUnitsInput
      • CreateReturnInput
      • CreateReturnResponse
      • Decimal
      • DeliveryDateRange
      • DeliveryMessage
      • DeliveryOfferDetails
      • DeliveryOfferFor
      • DeliveryOfferInfo
      • DeliveryOfferSummary
      • DeliveryPolicy
      • DeliveryPrice
      • DeliveryProduct
      • DeliveryRollupPrice
      • DeliveryTerms
      • DiscountAllocationDetails
      • DiscountAllocations
      • DiscountAllocationsSummary
      • DisplayMessage
      • ExternalProductIdentifier
      • FeaturedImage
      • Grading
      • GradingConditionInput
      • GradingInput
      • GradingSummary
      • GradingSummaryInput
      • ID
      • Int
      • LineItem
      • LineItemIdentifierInput
      • LocalizedString
      • Locator
      • Money
      • OrderIdentifierInput
      • OrderLineItemAmount
      • OrderLineItemAmountInput
      • OrderRevisionIdentifierInput
      • OrderRevisionInput
      • PackageInformation
      • PackageInformationDetails
      • PackageInformationDetailsFor
      • PackageInformationSummary
      • PackageMilestone
      • PackageMilestoneAddress
      • PackageMilestoneStatus
      • PackageTracker
      • PackageTrackerIdentifier
      • Payer
      • PaymentDetails
      • PaymentMethod
      • PaymentSummary
      • PaymentTerm
      • Payments
      • ProductDeliveryMessage
      • ProductId
      • ProductIdentifier
      • PurchaseGroupViewMember
      • PurchasedProductView
      • Recipient
      • RefundDetails
      • RefundFor
      • RefundTerm
      • RefundTotal
      • Return
      • ReturnDeliveryDetails
      • ReturnDeliveryDisplayMessage
      • ReturnDeliveryGroup
      • ReturnDeliveryGroupInput
      • ReturnDeliveryOffer
      • ReturnDeliveryOfferDetails
      • ReturnDeliveryOfferDetailsInput
      • ReturnDeliveryOfferInput
      • ReturnDeliveryTerm
      • ReturnDetails
      • ReturnExecutionStateInput
      • ReturnFor
      • ReturnForInput
      • ReturnIdentifierInput
      • ReturnLabel
      • ReturnLineItem
      • ReturnLineItemAmount
      • ReturnLineItemAmountInput
      • ReturnLineItemIdentifierInput
      • ReturnLineItemInput
      • ReturnPackageDetails
      • ReturnReason
      • ReturnReasonTerm
      • ReturnReasonTermInput
      • ReversalItem
      • ReversalItemIdentifier
      • ReversalItemIdentifierInput
      • ReversalItemInput
      • ReversalItemOfferSummary
      • ReversalItemOffers
      • ReversalOfferDetails
      • ReversalOfferInfo
      • ReversalOfferSummary
      • ReversalOffers
      • ReversalOffersInput
      • ReversalWindow
      • ShippingAddress
      • ShopperContact
      • SkuProductIdentifier
      • String
      • TaxSummary
      • Taxes
      • TrackingDetails
      • UpdateReturnInput
      • UpdateReturnResponse
      • VariationSelection
  • Privacy
    • Mutations
      • cancelPersonalDataDeletionTask
      • startPersonalDataDeletionTask
      • startPersonalDataRetrievalTask
    • Queries
      • personalDataDeletionTask
      • personalDataRetrievalTask
    • Objects
      • CancelPersonalDataDeletionTaskResponse
      • ClientToken
      • DataSubject
      • DataSubjectInput
      • DataSubjectTypeInput
      • ID
      • Int
      • PersonalDataDeletionTask
      • PersonalDataRetrievalTask
      • PersonalDataTaskError
      • StartPersonalDataDeletionTaskInput
      • StartPersonalDataDeletionTaskResponse
      • StartPersonalDataRetrievalTaskInput
      • StartPersonalDataRetrievalTaskResponse
      • String
  • Analytics
    • Mutations
      • sendUserEvents
      • startReportTask
    • Queries
      • reportDownloadLink
      • reportTask
    • Objects
      • AdditionalPropertiesInput
      • ClientType
      • ID
      • PropertyTuple
      • ReportDateRange
      • ReportDownloadLink
      • ReportRequest
      • SendUserEventInput
      • SendUserEventOutput
      • StartReportTaskInput
      • StartReportTaskResponse
      • String
      • UserEvent
  • Events
    • Mutations
      • createEventSubscription
      • deleteEventSubscription
    • Queries
      • eventSubscription
      • eventSubscriptions
    • Objects
      • AuthConfigInput
      • BasicAuthConfigInput
      • Boolean
      • ClientParameters
      • CreateEventSubscriptionInput
      • CreateEventSubscriptionResponse
      • DeleteEventSubscriptionResponse
      • DestinationData
      • DestinationInput
      • EventBridgeData
      • EventBridgeDataInput
      • EventSubscription
      • EventSubscriptionConnection
      • EventSubscriptionDetails
      • EventSubscriptionEdge
      • EventSubscriptionId
      • HttpMethodInput
      • HttpParameters
      • ID
      • Int
      • OAuthConfigInput
      • OauthHttpMethodInput
      • PageInfo
      • Parameter
      • String
      • WebhookDataInput
      • partnerEventSource
  • Tracking
    • Queries
      • packageTracker
    • Objects
      • DeliveryDateRange
      • LocalizedString
      • PackageMilestone
      • PackageMilestoneAddress
      • PackageMilestoneStatus
      • PackageTracker
      • PackageTrackerIdentifier
      • PackageTrackerIdentifierInput
      • PackageTrackerInput
      • String
  • Sandbox
    • Mutations
      • updateOrderPackageInformation
      • updateOrderReturns
    • Objects
      • Alias
      • AliasInput
      • AmazonSkuProductIdentifier
      • Amount
      • AmountInput
      • Boolean
      • CanceledFor
      • CancellationDetails
      • Cancellations
      • ConditionUnits
      • ConditionUnitsInput
      • Customer
      • Decimal
      • DeliveryDateRange
      • DeliveryMessage
      • DeliveryOfferDetails
      • DeliveryOfferFor
      • DeliveryOfferInfo
      • DeliveryOfferSummary
      • DeliveryPolicy
      • DeliveryPrice
      • DeliveryProduct
      • DeliveryRollupPrice
      • DeliveryTerms
      • DiscountAllocationDetails
      • DiscountAllocations
      • DiscountAllocationsSummary
      • DisplayMessage
      • ExternalProductIdentifier
      • FeaturedImage
      • Grading
      • GradingConditionInput
      • GradingInput
      • GradingSummary
      • GradingSummaryInput
      • ID
      • Int
      • LineItem
      • LineItemIdentifierInput
      • LocalizedString
      • Locator
      • Money
      • Order
      • OrderIdentifierInput
      • OrderLineItemAmount
      • OrderLineItemAmountInput
      • OrderLink
      • OrderMetadata
      • OrderRevisionIdentifierInput
      • OrderRevisionInput
      • OrderTotalSummary
      • PackageInformation
      • PackageInformationDetails
      • PackageInformationDetailsFor
      • PackageInformationDetailsForInput
      • PackageInformationDetailsReasonInput
      • PackageInformationDetailsStateInput
      • PackageInformationSummary
      • PackageMilestone
      • PackageMilestoneAddress
      • PackageMilestoneInput
      • PackageMilestoneStatus
      • PackageMilestoneStatusCodeInput
      • PackageMilestoneStatusInput
      • PackageTracker
      • PackageTrackerIdentifier
      • PackageTrackerIdentifierInput
      • Payer
      • PaymentDetails
      • PaymentMethod
      • PaymentSummary
      • PaymentTerm
      • Payments
      • ProductDeliveryMessage
      • ProductId
      • ProductIdentifier
      • PurchaseGroupViewMember
      • PurchasedProductView
      • Recipient
      • RefundDetails
      • RefundFor
      • RefundSummary
      • RefundTerm
      • RefundTotal
      • Refunds
      • ReturnDeliveryDetails
      • ReturnDeliveryDisplayMessage
      • ReturnDeliveryGroup
      • ReturnDeliveryOffer
      • ReturnDeliveryOfferDetails
      • ReturnDeliveryTerm
      • ReturnDetails
      • ReturnDetailsInput
      • ReturnFor
      • ReturnForInput
      • ReturnIdentifierInput
      • ReturnLabel
      • ReturnLineItem
      • ReturnLineItemAmount
      • ReturnLineItemAmountInput
      • ReturnLineItemIdentifierInput
      • ReturnLineItemInput
      • ReturnPackageDetails
      • ReturnPackageDetailsInput
      • ReturnPackageDetailsReasonInput
      • ReturnPackageDetailsStateInput
      • ReturnReason
      • ReturnReasonTerm
      • ReturnReasonTermInput
      • ReturnStateInput
      • Returns
      • ReturnsInput
      • ReversalOfferDetails
      • ReversalOfferInfo
      • ReversalOfferSummary
      • ReversalWindow
      • RollupCharge
      • ShippingAddress
      • ShopperContact
      • SkuProductIdentifier
      • String
      • TaxSummary
      • Taxes
      • TrackingDetails
      • UpdateOrderPackageInformationInput
      • UpdateOrderPackageInformationResponse
      • UpdateOrderReturnsInput
      • UpdateOrderReturnsResponse
      • UpdatePackageInformationDetailsInput
      • UpdatePackageInformationInput
      • UpdatePackageInformationStateInput
      • UpdatePackageStateInput
      • UpdatePackageTrackerStateInput
      • VariationSelection

Mutations

Version 2024-11-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