Version 0.13.0 Release Notes for the Buy with Prime Cartridge
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.
Version 0.13.0 of the Buy with Prime cartridge for Salesforce Commerce Cloud uses Buy with Prime API version 2024-11-01. Earlier versions of the cartridge use API version 2024-01-01.
The prerequisites for using the cartridge remain the same as for earlier versions of the cartridge. For details about dependencies, see Install the Buy with Prime Cartridge.
Consider the following changes in cartridge version 0.13.0.
SRI verification
The scripts included with the Buy with Prime cartridge now integrate Subresource Integrity (SRI) verification to help prevent tampering and unauthorized code injection. For details about SRI, in the Mozilla documentation see Subresource Integrity.
Version 2024-11-01 of the Buy with Prime API
The Buy with Prime cartridge has migrated to Buy with Prime API version 2024-11-01.
The cartridge now supports the following updated queries and mutations:
- Catalogs: createUploadLink, catalogFeed
- Delivery previews: deliveryPreview, shopperBwPEligibility
- Orders: createOrder, updateOrder
- Returns: reversalOffers
Catalogs: createUploadLink mutation
createUploadLink mutationFor the createUploadLink mutation, the following table shows changes to fields in the request:
| Previous field | New field | Description |
|---|---|---|
fileExtension | fileType | Field name changed |
For the createUploadLink mutation, the following table shows changes to fields in the response:
| Previous field | New field | Description |
|---|---|---|
| None | payload | New field |
fileId | fileId inside payload | Field moved inside payload |
uploadUrl | uploadUrl inside payload | Field moved inside payload |
Catalogs: catalogFeed query
catalogFeed queryFor the catalogFeed query, the following table shows changes to fields in the response:
| Previous field | New field | Description |
|---|---|---|
issues | None | Field removed |
| None | signals | New field |
Delivery previews: deliveryPreview query
deliveryPreview queryFor the deliveryPreview query, the following table shows changes to fields in the request:
| Previous field | New field | Description |
|---|---|---|
externalId | None | Field removed |
idPToken | None | Field removed |
idPTokenType | None | Field removed |
identityProvider | None | Field removed |
items | products | Field name changed |
inputItems | inputProducts | Field name changed |
quantity | amount | Field name changed |
| None | apayCheckoutSessionId | New field |
| None | lwaAccessToken | New field |
location in DeliveryPreviewTermsInput | location in DeliveryPreviewInput | Field moved |
shopperIdentity in DeliveryPreviewTermsInput | shopperIdentity in DeliveryPreviewInput | Field moved |
For the deliveryPreview query, the following table shows changes to fields in the response:
| Previous field | New field | Description |
|---|---|---|
items | products | Field name changed |
itemMessaging | productMessaging | Field name changed |
MskuItemIdentifier | AmazonSkuProductIdentifier | Field name changed |
quantity | amount | Field name changed |
ItemAmountUnavailable | ProductAmountUnavailable | Exception name changed |
ItemNotPrimeEnabled | ProductNotPrimeEnabled | Exception name changed |
ItemOutOfStock | ProductOutOfStock | Exception name changed |
charge in DeliveryOffer | price in DeliveryOffer | Field moved |
Delivery previews: shopperBwPEligibility query
shopperBwPEligibility queryFor the shopperBwPEligibility query, the following table shows changes to fields in the request:
| Previous field | New field | Description |
|---|---|---|
externalId | None | Field removed |
idPToken | None | Field removed |
idPTokenType | None | Field removed |
identityProvider | None | Field removed |
| None | apayCheckoutSessionId | New field |
| None | lwaAccessToken | New field |
Orders: createOrder mutation
createOrder mutationFor the createOrder mutation, the following table shows changes to fields in the request:
| Previous field | New field | Description |
|---|---|---|
externalId | None | Field removed |
idPToken | None | Field removed |
idPTokenType | None | Field removed |
identityProvider | None | Field removed |
| None | apayCheckoutSessionId | New field |
| None | lwaAccessToken | New field |
orderTotal | totalPrice | Field name changed |
orderAliases | aliases | Field name changed |
BUY_WITH_PRIME value for DeliveryProvider | AMAZON value for DeliveryProvider | Static string name changed |
For the createOrder mutation, for the CreateOrderResponse response, the following table shows changes to fields in the Order object:
| Previous field | New field | Description |
|---|---|---|
id in CreateOrderOutput | id in Order | Field moved |
orderLinks in CreateOrderOutput | orderLinks in Order | Field moved |
purchasedItem in Order | product in Order | Field name changed |
Orders: updateOrder mutation
updateOrder mutationFor the updateOrder mutation, the following table shows changes to fields in the request:
| Previous field | New field | Description |
|---|---|---|
| None | orderIdentifier | New field |
orderId: ID in UpdateOrderInput | None | Field removed |
Returns: generateReversalOffers query
generateReversalOffers queryThe generateReversalOffers query has been renamed to reversalOffers.
For the reversalOffers query, the following table shows changes to fields in the request:
| Previous field | New field | Description |
|---|---|---|
| None | resolutionTypes | New field |
For the reversalOffers query, the following table shows changes to fields in the response:
| Previous field | New field | Description |
|---|---|---|
title as string | title as LocalizedString | Data type changed |
description as string | description as LocalizedString | Data type changed |
reversalOfferGroups | reversalOfferCollection | Field name changed |
Related topics
Updated 6 days ago