order
A placed order — available on the order status and customer account pages.
Refund credit outcomes
order.refund_credit_outcomes is an array of completed store-credit refund
outcomes. It defaults to an empty array when absent. Each row contains:
| Row field | Meaning |
|---|---|
refund_id | Identifier of the successful refund. |
restored_amount_cents | Credit actually restored by this refund, as a decimal string in the order currency’s minor units. |
withheld_reward_amount_cents | Original promotional value not restored as spendable credit because its restrictions prevent restoration, as a decimal string in minor units. |
These fields describe the credit part of a refund, not its gateway payment amount. Restoring promotional credit does not renew its original expiry or remove its restrictions. Ordinary non-promotional credit has a separate renewal rule explained in the store-credit guide. Do not present withheld value as wallet balance or subtract it again from an external payment refund.
{% for outcome in order.refund_credit_outcomes %} <p>Store credit restored: {{ outcome.restored_amount_cents | money }}</p> <p>Promotional credit not restored: {{ outcome.withheld_reward_amount_cents | money }}</p>{% endfor %}For an INR refund with "5000" restored and "10000" withheld, the example
shows ₹50 restored and ₹100 promotional credit not restored. It does
not claim that ₹150 was added to the wallet. The amounts remain strings in the
public data so large minor-unit values are not rounded by JavaScript numbers.
The source includes only successful refunds with a posted credit outcome; pending refunds and refunds without a credit outcome have no row. These personal details are removed from non-owner order views and may be absent from list results. An empty array therefore does not prove that an order has never been refunded. Never use it as the order’s refund-status test or expose private order HTML through a shared public cache.
See Store credit and Rewards: settings and recovery for promotional recovery, expiry and retry behavior.
Properties
| Property | Description |
|---|---|
order.additive_tax | Currency amount for additive tax, in the store currency’s minor unit unless the object reference states otherwise. |
order.amount_paid | Currency amount for amount paid, in the store currency’s minor unit unless the object reference states otherwise. |
order.attributes | Custom cart attributes. |
order.attribution | Buyer-visible attribution value for this order. |
order.b2b | Company purchase snapshot (company/location names, PO number, payment plan, terms and due date, receivable state), or nil for a D2C order. |
order.billing_address | Billing address. |
order.buyer_pending_payment_instructions | Buyer-visible buyer pending payment instructions. |
order.buyer_pending_payment_instructions_uses_default | Buyer-visible buyer_pending_payment_instructions_uses_default value for this order. |
order.cancel_reason | Reason for cancellation. |
order.cancel_reason_label | Buyer-visible cancel reason label. |
order.canceled | Buyer-visible canceled value for this order. |
order.canceled_at | ISO timestamp for canceled, or nil when unavailable. |
order.cancelled | true when cancelled. |
order.cancelled_at | Cancellation timestamp. |
order.cart_level_discount_applications | Buyer-visible cart_level_discount_applications value for this order. |
order.company_location_tax_id | Tax registration ID of the purchasing company location as stamped on the order, or nil for a D2C order. |
order.confirmation_number | Buyer-visible confirmation_number value for this order. |
order.created_at | Creation timestamp. |
order.currency | Currency (ISO code or object). |
order.customer | Buyer-visible customer value for this order. |
order.customer_order_url | Buyer-visible URL for customer order, or nil/empty when unavailable. |
order.customer_url | Customer-facing order URL. |
order.delivery_url | Buyer-visible URL for delivery, or nil/empty when unavailable. |
order.discount_applications | Discounts applied. |
order.effective_tax_exempt | true when the order was taxed as exempt under the exemption in force at placement. |
order.email | Email address. |
order.estimated_delivery | Buyer-visible estimated_delivery value for this order. |
order.financial_status | Payment status (paid, pending, refunded…). |
order.financial_status_label | Buyer-visible financial status label. |
order.fulfillment_status | Fulfillment status. |
order.fulfillment_status_label | Buyer-visible fulfillment status label. |
order.fulfillments | Buyer-visible fulfillments value for this order. |
order.gift_card_applied_amount | Currency amount for gift card applied amount, in the store currency’s minor unit unless the object reference states otherwise. |
order.id | Unique identifier. |
order.included_tax | Currency amount for included tax, in the store currency’s minor unit unless the object reference states otherwise. |
order.item_count | Total quantity across all lines. |
order.line_items | Order lines. |
order.line_items_subtotal_price | Currency amount for line items subtotal price, in the store currency’s minor unit unless the object reference states otherwise. |
order.manual_payment_reference_label | Buyer-visible manual payment reference label. |
order.manual_payment_settlement_policy | Buyer-visible manual_payment_settlement_policy value for this order. |
order.metafields | Metafields on this resource. |
order.name | Name. |
order.note | Cart note from the buyer. |
order.order_number | Sequential order number. |
order.order_status_url | Buyer-visible URL for order status, or nil/empty when unavailable. |
order.out_of_zone_tax_adjustment | Buyer-visible out_of_zone_tax_adjustment value for this order. |
order.payment_method_kind | Public payment method kind value. |
order.payment_method_manual_kind | Public payment method manual kind value. |
order.payment_method_name | Buyer-visible payment method name. |
order.payment_method_uses_default_description | Buyer-visible payment_method_uses_default_description value for this order. |
order.payment_method_uses_default_name | Buyer-visible payment method uses default name. |
order.phone | Phone number. |
order.pickup_in_store | Buyer-visible pickup_in_store value for this order. |
order.pickup_in_store? | Boolean predicate for pickup_in_store on this order. |
order.post_purchase | Buyer-visible post_purchase value for this order. |
order.refund_credit_outcomes | Buyer-visible refund_credit_outcomes value for this order. |
order.shipping_address | Shipping address. |
order.shipping_methods | Chosen shipping methods. |
order.shipping_price | Shipping charge. |
order.show_buyer_pending_payment_instructions | true when this order should show buyer pending payment instructions. |
order.show_buyer_pending_payment_instructions? | Boolean predicate for show_buyer_pending_payment_instructions on this order. |
order.store_credit_applied_amount | Currency amount for store credit applied amount, in the store currency’s minor unit unless the object reference states otherwise. |
order.subtotal_line_items | Buyer-visible subtotal_line_items value for this order. |
order.subtotal_price | Subtotal before shipping and taxes. |
order.tags | Tags as an array of strings. |
order.tax_display | Buyer-visible tax_display value for this order. |
order.tax_exemption_owner_id | Identifier for the related tax exemption owner record, or nil/empty when unavailable. |
order.tax_exemption_owner_type | Public tax exemption owner type value. |
order.tax_label | Buyer-visible tax label. |
order.tax_lines | Tax breakdown lines. |
order.tax_price | Currency amount for tax price, in the store currency’s minor unit unless the object reference states otherwise. |
order.total_discounts | Currency amount for total discounts, in the store currency’s minor unit unless the object reference states otherwise. |
order.total_duties | Currency amount for total duties, in the store currency’s minor unit unless the object reference states otherwise. |
order.total_net_amount | Currency amount for total net amount, in the store currency’s minor unit unless the object reference states otherwise. |
order.total_outstanding | Currency amount for total outstanding, in the store currency’s minor unit unless the object reference states otherwise. |
order.total_price | Total after discounts. |
order.total_refunded_amount | Currency amount for total refunded amount, in the store currency’s minor unit unless the object reference states otherwise. |
order.transactions | Payment transactions. |
Property list is generated from the storefront engine (OrderDrop), so it always matches what your theme can use. Use {{ order | json }} only as a curated debug snapshot; it can omit lazy or otherwise public properties.