get_order
Retrieve complete details for a specific Amazon order by Order ID, with optional site selection, to inspect order information and answer order-related questions.
Instructions
Get the full details for a given Amazon Order ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site | No | The Amazon site to read, e.g. `amazon.de`, since each site has its own orders. By default, the user's default site (see `check_session`). | |
| order_id | Yes | The Amazon Order ID to lookup. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | Where the Order appeared in the history when it was queried. This will inevitably change (e.g. when a new Order is placed, all indexes will then be off by one), but is still captured as it may be applicable in various use-cases. Populated when the Order was fetched through `get_orders` (use `start_index` to correlate), or when the `clone` has its `index` set. | |
| items | No | The Order Items. | |
| subtotal | No | The Order subtotal. Only populated when `full_details` is `True`. | |
| cancelled | No | `True` if the Order was cancelled. When `True`, fields like `grand_total` and the totals on the details page may be `None` because Amazon stops rendering them. | |
| gift_card | No | The Gift Card total (rendered as "Gift Card" on digital order details pages), as a negative amount. Only populated when `full_details` is `True`. | |
| gift_wrap | No | The Gift Wrap total. Only populated when `full_details` is `True`. | |
| recipient | No | The Order Recipients. | |
| shipments | No | The Order Shipments. | |
| item_count | No | The number of items in the purchase, when Amazon summarizes the count instead of listing the items (e.g. Whole Foods Market orders show "N items in this purchase"). `None` when no such summary is shown. | |
| grand_total | No | The Order grand total. | |
| full_details | No | If the Orders full details were populated from its details page. | |
| order_number | No | The Order number. May be `None` only when the Order is `cancelled` and Amazon stripped the order number from the details page (the `order_number` parameter is used as a fallback in that case). | |
| refund_total | No | The Order refund total. Only populated when `full_details` is `True`. | |
| estimated_tax | No | The Order estimated tax. Only populated when `full_details` is `True`. For Whole Foods Market orders this is the "Tax and Fees" total from the receipt. | |
| free_shipping | No | The Order free shipping, as a negative amount. Only populated when `full_details` is `True`. | |
| reward_points | No | The Order reward points, as a negative amount of currency (not a count of points). Only populated when `full_details` is `True`. | |
| coupon_savings | No | The Order coupon savings, as a negative amount. Only populated when `full_details` is `True`. | |
| is_whole_foods | No | `True` if this is a Whole Foods Market purchase (an in-store/FOPO purchase or a Whole Foods receipt order). Unlike other unsupported order types, these expose a `grand_total` and (often) an `item_count` on the history page, so those fields are populated. | |
| payment_method | No | The Order payment method. Only populated when `full_details` is `True`. For Whole Foods Market orders this is the card brand of the first payment method on the receipt (e.g. "Visa"). | |
| shipping_total | No | The Order shipping total. Only populated when `full_details` is `True`. | |
| amazon_discount | No | The Amazon discount, as a negative amount. Only populated when `full_details` is `True`. | |
| total_before_tax | No | The Order total before tax. Only populated when `full_details` is `True`. | |
| multibuy_discount | No | The Multibuy discount, as a negative amount. Only populated when `full_details` is `True`. | |
| order_placed_date | No | The Order placed date. | |
| promotion_applied | No | The Order promotion applied, as a negative amount. Only populated when `full_details` is `True`. | |
| order_details_link | No | The Order details link. | |
| payment_method_last_4 | No | The Order payment method's last 4 digits, preserved verbatim so leading zeros are not lost. Only populated when `full_details` is `True`. | |
| subscription_discount | No | The Order Subscribe & Save discount, as a negative amount. Only populated when `full_details` is `True`. |