DeliveryOfferDetails

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.

Overview

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

Fields

FieldDescription
deliveryCharge (Money)

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

deliveryPreviewId (ID)

Identifier for the DeliveryPreview generated by Buy with Prime associated with this delivery offer for the item. If the deliveryProvider is PRIME, then this value will be populated. If the deliveryProvider is MERCHANT, then this value can be null.

deliveryProvider (String required)

Details about the fulfillment/delivery offer provider.

The value is constrained to one of the following

valuedescription
PRIMEDenotes the fulfillment provider is Buy with Prime.
MERCHANTIndicates fulfillment is managed by merchant.
discounts (DiscountAllocations)

Promotional discounts that applies to the delivery offer.

estimatedDeliveryDate (ISODateRange)

Estimated delivery date range associated with delivery offer.

id (ID)

Identifier for the selected delivery offer by the customer. If the deliveryProvider is PRIME, then this value will be populated. If the deliveryProvider is MERCHANT, then this value can be null.

lineItemAssociations ([LineItemAssociation])

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

policy (DeliveryPolicy)

Represents the policy information associated with the delivery offering

recipient (Recipient required)

The recipient for the items in the delivery offer.

taxes (Taxes)

The representation of the delivery tax details.