class Falsify::Order

An order is a customer's completed request to purchase one or more products from a shop. See the [API documentation](help.shopify.com/en/api/reference/orders/order). Required Fields:

Attributes

app_id[R]

The ID of the app that created the order. @return [String]

billing_address[RW]

The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method. @return [Address]

browser_ip[R]

The IP address of the browser used by the customer when they placed the order. @return [String]

buyer_accepts_marketing[RW]

Whether the customer consented to receive email updates from the shop. @return [Boolean]

cancelled_at[R]

The date and time ([ISO 8601](en.wikipedia.org/wiki/ISO_8601) format) when the order was canceled. @return [String]

cart_token[R]

The ID of the cart that's associated with the order. @return [String]

client_details[R]

Information about the browser that the customer used when they placed their order: @return [ClientDetails]

closed_at[R]

The date and time ([ISO 8601](en.wikipedia.org/wiki/ISO_8601) format) when the order was closed. @return [String]

created_at[R]

The autogenerated date and time ([ISO 8601](en.wikipedia.org/wiki/ISO_8601) format) when the order was created in Shopify. The value for this property cannot be changed. @return [String]

currency[RW]

The three-letter code ([ISO 4217](en.wikipedia.org/wiki/ISO_4217) format) for the shop currency. @return [String]

customer[RW]

Information about the customer. The order might not have a customer and apps should not depend on the existence of a `customer` object. This value might be `null` if the order was created through Shopify POS. For more information about the `customer` object, see the [Customer resource](help.shopify.com/en/api/reference/customers/customer). @return [Customer,nil]

customer_locale[R]

The two or three-letter language code, optionally followed by a region modifier. @return [String]

discount_applications[RW]

@return [Array<DiscountApplication>]

discount_codes[RW]

@return [Array<DiscountCode>]

email[RW]

The customer's email address. @return [String]

fulfillments[RW]

A list of fulfillments associated with the order. For more information, see the [Fulfillment API](help.shopify.com/en/api/reference/shipping-and-fulfillment/fulfillment). @return [Array<Fulfillment>]

gateway[R]

The payment gateway used. @deprecated Use the [Transaction resource](help.shopify.com/en/api/reference/orders/transaction) instead. @return [String]

landing_site[R]

The URL for the page where the buyer landed when they entered the shop. @return [String]

line_items[RW]

A list of line item objects, each containing information about an item in the order. @return [Array<LineItem>]

location_id[RW]

The ID of the physical location where the order was processed. @return [String]

name[R]

The order name as represented by a number. Must start with `#`. @return [String]

note[RW]

An optional note that a shop owner can attach to the order. @return [String]

note_attributes[RW]

Extra information that is added to the order. Appears in the **Additional details** section of an order details page. Each array entry must contain a hash with `name` and `value` keys. @return [Array<Hash>]

number[R]

For internal use only. An ID unique to the shop. Numbers are sequential and start at 1000. @return [String]

order_number[R]

The ID of the order used by the shop owner and customer. This is different from the `shopify_id` property, which is the ID of the order used by the API. @return [String]

order_status_url[R]

The URL pointing to the [order status web page](help.shopify.com/manual/orders/status-tracking), if applicable. @return [String]

payment_details[R]

An object containing information about the payment. @deprecated Use the [Transaction resource](help.shopify.com/en/api/reference/orders/transaction) instead. @return [String]

payment_gateway_names[R]

The list of payment gateways used for the order. @return [Array<String>]

phone[RW]

The customer's phone number for receiving SMS notifications. @return [String]

presentment_currency[RW]

The presentment currency that was used to display prices to the customer. @return [String]

processed_at[RW]

The date and time ([ISO 8601](en.wikipedia.org/wiki/ISO_8601) format) when an order was processed. This value is the date that appears on your orders and that's used in the analytic reports. By default, it matches the `created_at` value. If you're importing orders from an app or another platform, then you can set `processed_at` to a date and time in the past to match when the original order was created. @return [String]

referring_site[RW]

The website where the customer clicked a link to the shop. @return [String]

refunds[R]

A list of refunds applied to the order. For more information, see the [Refund API](help.shopify.com/en/api/reference/orders/refund). @return [Array<Refund>]

shipping_address[RW]

The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping. @return [Address]

shipping_lines[RW]

An array of objects, each of which details a shipping method used. @return [Array<ShippingLine>]

shopify_id[R]

The ID of the order, used for API purposes. This is different from the `order_number` property, which is the ID used by the shop owner and customer. @return [String]

source_name[RW]

Where the order originated. Can be set only during order creation, and is not writeable afterwards. Values for Shopify channels are protected and cannot be assigned by other API clients: `web`, `pos`, `shopify_draft_order`, `iphone`, and `android`. Orders created via the API can be assigned any other string of your choice. If unspecified, then new orders are assigned the value of your app's ID. @return [String]

subtotal_price[RW]

The price of the order in the shop currency after discounts but before shipping, taxes, and tips. @return [String]

subtotal_price_set[RW]

The subtotal of the order in shop and presentment currencies. @return [PriceSet]

tags[RW]

Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length. @return [String]

tax_lines[RW]

An array of tax line objects, each of which details a tax applicable to the order. @return [Array<TaxLine>]

taxes_included[RW]

Whether taxes are included in the order subtotal. @return [Boolean]

test[RW]

Whether this is a test order. @return [Boolean]

token[R]

A unique token for the order. @return [String]

total_discounts[RW]

The total discounts applied to the price of the order in the shop currency. @return [String]

total_discounts_set[RW]

The total discounts applied to the price of the order in shop and presentment currencies. @return [PriceSet]

total_line_items_price[RW]

The sum of all line item prices in the shop currency. @return [String]

total_line_items_price_set[RW]

The total of all line item prices in shop and presentment currencies. @return [String]

total_price[RW]

The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive. @return [String]

total_price_set[RW]

The total price of the order in shop and presentment currencies. @return [PriceSet]

total_tax[RW]

The sum of all the taxes applied to the order in the shop currency. Must be positive. @return [String]

total_tax_set[RW]

The total tax applied to the order in shop and presentment currencies. @return [PriceSet]

total_tip_received[RW]

The sum of all the tips in the order in the shop currency. @return [String]

total_weight[RW]

The sum of all line item weights in grams. @return [String]

updated_at[R]

The date and time ([ISO 8601](en.wikipedia.org/wiki/ISO_8601) format) when the order was last modified. Filtering orders by `updated_at` is not an effective method for fetching orders because its value can change when no visible fields of an order have been updated. Use the [Webhook](help.shopify.com/en/api/reference/events/webhook) and [Event](help.shopify.com/en/api/reference/events/event) APIs to subscribe to order events instead. @return [String]

user_id[RW]

The ID of the user logged into Shopify POS who processed the order, if applicable. @return [String]