OrderTotalSummary

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 the summary of charges on the order by rolling up different charges appropriately and categorizing them into a high level view.

Typically provides the following summary:

  • Order Total Price - Represents the total on the order to be charged to shopper.
  • Order Subtotal - Represents the total price of items part of the order.
  • Order Total Shipping - Represents the total shipping charges on the order.
  • Order Total Tax - Represents the total tax charges on the order.

Fields

FieldDescription
rollupCharges ([RollupCharge])

List of charges rolled up by type.

value (Money)

Represents the total on the order to be charged to shopper based on the charges listed under rollupCharges.

verified (Boolean)

Indicates whether the data provided in OrderTotalSummary was generated and verified by Buy with Prime. If false, the monetary values represented in the charges and totals here may not accurately represent the summary of charges for the order.