📘

Buy with Prime API is now available for early access

Sign up for early access to the Buy with Prime API using the 'Sign Up' button below. The API may change as Amazon receives feedback and iterates on it.

Sign Up

December 30, 2024

PurchaseGroupViewMember is now available.

November 22, 2024

The following changes were made to the Buy with Prime API v2024-04-01.

Order interface

• ReturnDetails now includes the fields returnDeliveryDetails and returnLineItems.

Returns interface

The following APIs in the Returns interface are changed:

• The query generateReversalOffers is now reversalOffers.
• In ReversalOffers, the field ReversalOfferGroups is now ReversalItemOffers.
• ReversalOfferGroupSummary is now ReversalItemOfferSummary
• ReversalItemOfferSummary now includes the fields window and resolutionTypes.

May 13, 2024

This changelog lists the updates associated with Buy with Prime API v2024-04-01.

• Backwards-incompatible changes
• Backwards-compatible changes

Backwards-incompatible changes

v2024-04-01 of the Buy with Prime API has the following backwards-incompatible updates from the v2024-01-01 version. These updates require code changes on your end if you decide to migrate to this version.

Catalog interface

The "mapping product" concept was replaced by the "product" concept. This resulted in the following changes:

• The mappingProduct query was renamed to product. There is now also a products query to retrieve multiple products from the Buy with Prime catalog in one API call.
• The MappingProduct object was renamed to Product, and the following fields were renamed:
  • productExternalId was renamed to externalId.
  • productSku was renamed to sku.
  • productMsku was renamed to amazonSku.
  • isPrimeIntended was renamed to offerPrime.
  • url was renamed to productDetailPageUrl.
• The MskuProductIdentifier object was renamed to AmazonSkuProductIdentifier.
• The Issue object was removed. Use the Signal object instead.
• For the createUploadLink mutation:
  • The fileExtension field in the input was renamed to fileType.
  • The createUploadLink mutation now returns a CreateUploadLinkResponse object that contains the upload link as a field, instead of returning the upload link itself.

Delivery Preview interface

• In the input to the deliveryPreview query, the items field was renamed to products, which resulted in the following additional changes:
  • The DeliveryItemInput object was renamed to DeliveryProductInput, and the quantity field was renamed to amount.
  • The DeliveryItem object was renamed to DeliveryProduct.
  • The itemMessaging field of the DeliveryPolicy object was renamed to productMessaging.
  • The exceptions are now ProductAmountUnavailable, ProductNotPrimeEnabled, and ProductOutOfStock.
• The DeliveryOffer object no longer has a charge field.

Order interface

• The createOrder and updateOrder mutations now return the entire order.
• In the CreateOrderInput object, the orderTotal field was replaced by the totalPrice field.
• In the LineItem object, the purchasedItem field was renamed to product.
• The CanceledOrderLineItem object was removed.
• The association field of the DeliveryInformation object was removed. To access order line items associated with the delivery information, use the deliveryInformationDetailsFor field of the DeliveryInformationDetails object.
• The following events were renamed:
  • ITEM_CANCELLED was renamed to DELIVERY_CANCELLED.
  • ITEM_DELIVERED was renamed to DELIVERY_COMPLETED.
  • ITEM_IN_TRANSIT was renamed to DELIVERY_IN_TRANSIT.

Return interface

• The generateReversalOffers query was renamed to reversalOffers.
• The ReversalOfferGroup object was renamed to ReversalItemOffers.
• In the ReversalOffers object, the reversalOfferGroups field was replaced by reversalOfferCollection.
• In the ReturnFor object, the orderLineItems field now contains a list of OrderLineItemAmount objects instead of ReturnOrderLineItem objects.
• The returned ReversalOffers now provide locale information rather than just en-US strings without locale information.

Refund interface

• In the RefundFor object, the orderLineItems field now contains a list of OrderLineItemAmount objects instead of RefundedOrderLineItem objects.
• refundTotal is now a required field in RefundDetailsInput.

Privacy interface

• The createPrivacyRequest mutation was replaced by startPersonalDataRetrievalTask and startPersonalDataDeletionTask.
• The privacyRequest query was replaced by personalDataRetrievalTask and personalDataDeletionTask.
• The cancelPrivacyRequest mutation was renamed to cancelPersonalDataDeletionTask.

Event interface

• Event interface mutations and queries were removed. To subscribe to events, work with your Buy with Prime solutions architect.

Backwards-compatible changes

v2024-04-01 of the Buy with Prime API has the following backwards-compatible updates from the v2024-01-01 version.

Catalog interface

• There are three new mutations:
  • createProduct
  • updateProduct
  • deleteProduct
• The FeaturedImageInput object now contains an alttext string field that you can use to specify the image alt text, which is not supported by the CSV.
• In the catalog feed processing result CSV file, there are now "Error Type(s)" and "Error Code(s)" columns. For details, see Get the Result of a Catalog Upload. Update your CSV-parsing logic to handle the two new fields and their machine-friendly values.

Return interface

• There is now a resolutionTypes tag to indicate return eligibility in the API response to explicitly indicate returnability with resolution type value 'RETURN'. You no longer need to rely on a string match with the reversal offer summary view.

Privacy interface

• There are four new events:
  • PERSONAL_DATA_DELETION_TASK_COMPLETED
  • PERSONAL_DATA_DELETION_TASK_FAILED
  • PERSONAL_DATA_RETRIEVAL_TASK_COMPLETED
  • PERSONAL_DATA_RETRIEVAL_TASK_FAILED