DeliveryOfferDetailsInput

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.

Overview

Represents customer's delivery offer selection during checkout. If the delivery offer is a Buy with Prime delivery offer, then this should be used.

Arguments

ArgumentDescription
deliveryCharge (MoneyInput)

This represents the estimated fee that the merchant will charge the shopper.

deliveryFor (DeliveryOfferForInput)

Line item associations for the items in the delivery group. This can be useful especially if this delivery offer spans across several line items.

If the delivery offer is only constrained to one line item and is not associated with multiple line items this can be nullable.

deliveryPreviewId (ID)

Identifier for the DeliveryPreview generated by Amazon associated with this delivery offer for the item. If the deliveryProvider is AMAZON and Prime delivery is requested using deliveryTerms.isPrimeEligible then you must provide this ID. If the deliveryProvider is MERCHANT or if Prime delivery isn't requested, then this is an optional field.

deliveryProvider (DeliveryProviderInput required)

Details about the fulfillment/delivery offer provider.

The value is constrained to one of the following

valuedescription
AMAZONDenotes the fulfillment provider is Amazon.
MERCHANTIndicates fulfillment is managed by merchant.
deliveryTerms (DeliveryTermsInput)

Terms associated with the delivery. If a delivery offer is not generated previously, one will be generated based on the provided terms.

discounts (DiscountAllocationInput)

Promotional discounts allocated to the delivery offer.

id (ID)

Identifier for the selected delivery offer by the customer among the presented ones. If the deliveryProvider is AMAZON and Prime delivery is requested using deliveryTerms.isPrimeEligible then you must provide this ID. If the deliveryProvider is MERCHANT or if Prime delivery isn't requested, then this is an optional field.

taxes (TaxInput)

The tax(es) applied on this delivery offer.