---
title: "order"

doc_type: static
doc_category: static
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/docs/sline/object/order'
  md: 'https://developer.shopline.com/docs/sline/object/order.md'
---

# order


    An [order](https://help.shopline.com/hc/en-001/articles/14266668346137-Orders-Overview).

    



    <div>
    
        #### Properties

        
<ObjectProperty 
    name="attributes"
    types={[""]}
>
<ObjectSummary>
The attributes on the order. If there are no attributes on the order, then `null` is returned.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="billing_address"
    types={["address"]}
>
<ObjectSummary>
The billing address of the order.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="cancel_reason"
    types={["string"]}
>
<ObjectSummary>
The reason that the order was cancelled.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="cancelled"
    types={["boolean"]}
>
<ObjectSummary>
Returns `true` if the order was cancelled. Returns `false` if not.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="cancelled_at"
    types={["string"]}
>
<ObjectSummary>
A timestamp of the order cancellation time.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="created_at"
    types={["string"]}
>
<ObjectSummary>
A timestamp of the order creation time.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="customer_url"
    types={["string"]}
>
<ObjectSummary>
The URL for the customer to view the order in their account.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="email"
    types={["string"]}
>
<ObjectSummary>
The email that's associated with the order. If no email is associated with the order, then `null` is returned.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="financial_status"
    types={["number"]}
>
<ObjectSummary>
The order's financial status.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="financial_status_label"
    types={["string"]}
>
<ObjectSummary>
The localized version of the financial status of the order.

:::tip{title="TIP"} 
Use this property to output the financial status on the storefront.
:::
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="fulfillment_status"
    types={["number"]}
>
<ObjectSummary>
The fulfillment status of the order.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="fulfillment_status_label"
    types={["string"]}
>
<ObjectSummary>
The localized version of the fulfillment status of the order.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="id"
    types={["string"]}
>
<ObjectSummary>
The ID of the order.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="item_count"
    types={["number"]}
>
<ObjectSummary>
The number of items in the order.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="line_items"
    types={["array of line_item"]}
>
<ObjectSummary>
The line items in the order.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="line_items_subtotal_price"
    types={["number"]}
>
<ObjectSummary>
The sum of the prices of all of the line items in the order in the currency's subunit, after any line item discounts have been applied. The value is output in the customer's local (presentment) currency.

:::tip{title="TIP"} 
Use `money_with_currency` helper to output a formatted amount. 
:::
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="name"
    types={["string"]}
>
<ObjectSummary>
The name of the order.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="note"
    types={["string"]}
>
<ObjectSummary>
The note on the order. If there's no note on the order, then `null` is returned.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="order_number"
    types={["string"]}
>
<ObjectSummary>
The integer string representation of the order name.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="order_status_url"
    types={["string"]}
>
<ObjectSummary>
The URL for the [order status page](https://help.shopline.com/hc/en-001/articles/14266668346137-Orders-Overview) for the order.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="shipping_address"
    types={["address"]}
>
<ObjectSummary>
The shipping address of the order.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="shipping_methods"
    types={["array of shipping_method"]}
>
<ObjectSummary>
The shipping address of the order.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="shipping_price"
    types={["number"]}
>
<ObjectSummary>
The shipping price of the order in the currency's subunit. The value is output in the customer's local (presentment) currency.

:::tip{title="TIP"} 
Use `money_with_currency` helper to output a formatted amount. 
:::
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="tags"
    types={["array of string"]}
>
<ObjectSummary>
The tags on the order. The tags are returned in alphabetical order.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="tax_price"
    types={["number"]}
>
<ObjectSummary>
The total amount of taxes applied to the order in the currency's subunit. The value is output in the customer's local (presentment) currency.

> **TIP**
>
> Use `money_with_currency` helper to output a formatted amount.
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="total_discounts"
    types={["number"]}
>
<ObjectSummary>
The total amount of all discounts applied to the order in the currency's subunit. The value is output in the customer's local (presentment) currency.

:::tip{title="TIP"} 
Use `money_with_currency` helper to output a formatted amount. 
:::
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="total_net_amount"
    types={["number"]}
>
<ObjectSummary>
The net amount of the order in the currency's subunit. The value is output in the customer's local (presentment) currency.

:::tip{title="TIP"} 
Use `money_with_currency` helper to output a formatted amount. 
:::
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="total_price"
    types={["number"]}
>
<ObjectSummary>
The total price of the order in the currency's subunit.

:::tip{title="NOTE"} 
The total price is calculated before refunds are applied. Use `order.total_net_amount` to output the total minus any refunds. 
:::

The value is output in the customer's local (presentment) currency.

:::tip{title="TIP"} 
Use `money_with_currency` helper to output a formatted amount. 
:::
</ObjectSummary>
</ObjectProperty>
        
    
    </div>