RollupCharge

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

Aggregation of charges grouped by type. Also provides a computed rolled up charge value.

Fields

FieldDescription
displayString (String)

Human readable string for the charge, meant to be used for display purposes.

rollupChargeType (String)

Type of rollup charge.

The value is constrainted to one of the following

valuedescription
ORDER_SUB_TOTALRepresents the total price of items part of the order.
ORDER_TAXRepresents the total tax charges on the order.
ORDER_SHIPPINGRepresents the total shipping charges on the order.
REFUND_TOTAL_FEESRepresents the total fee collected by the merchant from refund.
REFUND_DISCREPANCYRepresents refund discrepancy due to refund override performed by the merchant.
DISCOUNTRepresents the discount value for a promotion.
value (Money)

Total value that was rolled up for this type.