--- title: Order - GraphQL Admin description: >- The `Order` object represents a customer's request to purchase one or more products from a store. Use the `Order` object to handle the complete purchase lifecycle from checkout to fulfillment. Use the `Order` object when you need to: - Display order details on customer account pages or admin dashboards. - Create orders for phone sales, wholesale customers, or subscription services. - Update order information like shipping addresses, notes, or fulfillment status. - Process returns, exchanges, and partial refunds. - Generate invoices, receipts, and shipping labels. The `Order` object serves as the central hub connecting customer information, product details, payment processing, and fulfillment data within the GraphQL Admin API schema. > Note: > Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older records, > then you need to [request access to all orders](https://shopify.dev/docs/api/usage/access-scopes#orders-permissions). If your app is granted > access, then you can add the `read_all_orders`, `read_orders`, and `write_orders` scopes. > Caution: > Only use orders data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/docs/api/usage/access-scopes#requesting-specific-permissions) for apps that don't have a legitimate use for the associated data. Learn more about [building apps for orders and fulfillment](https://shopify.dev/docs/apps/build/orders-fulfillment). api_version: 2026-04 source_url: html: 'https://shopify.dev/docs/api/admin-graphql/latest/objects/Order' md: 'https://shopify.dev/docs/api/admin-graphql/latest/objects/Order.md' api_name: admin api_type: graphql type: object metadata: domain: admin --- # Order object Requires `read_orders` access scope, `read_marketplace_orders` access scope or `read_quick_sale` access scope. The `Order` object represents a customer's request to purchase one or more products from a store. Use the `Order` object to handle the complete purchase lifecycle from checkout to fulfillment. Use the `Order` object when you need to: * Display order details on customer account pages or admin dashboards. * Create orders for phone sales, wholesale customers, or subscription services. * Update order information like shipping addresses, notes, or fulfillment status. * Process returns, exchanges, and partial refunds. * Generate invoices, receipts, and shipping labels. The `Order` object serves as the central hub connecting customer information, product details, payment processing, and fulfillment data within the GraphQL Admin API schema. *** **Note:** Only the last 60 days\' worth of orders from a store are accessible from the \Order\ object by default. If you want to access older records, then you need to \request access to all orders\. If your app is granted access, then you can add the \\read\\_all\\_orders\\, \\read\\_orders\\, and \\write\\_orders\\ scopes. *** *** **Caution:** Only use orders data if it\'s required for your app\'s functionality. Shopify will restrict \access to scopes\ for apps that don\'t have a legitimate use for the associated data. *** Learn more about [building apps for orders and fulfillment](https://shopify.dev/docs/apps/build/orders-fulfillment). ## Fields * additional​Fees [\[Additional​Fee!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/AdditionalFee) non-null A list of additional fees applied to an order, such as duties, import fees, or [tax lines](https://shopify.dev/docs/api/admin-graphql/latest/objects/order#field-Order.fields.additionalFees.taxLines). * agreements [Sales​Agreement​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SalesAgreementConnection) non-null A list of sales agreements associated with the order, such as contracts defining payment terms, or delivery schedules between merchants and customers. * after [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * first [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * query [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax). * happened\_at time * id id Filter by `id` range. Example: * `id:1234` * `id:>=1234` * `id:<=1234` * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * alerts [\[Resource​Alert!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceAlert) non-null A list of messages that appear on the **Orders** page in the Shopify admin. These alerts provide merchants with important information about an order's status or required actions. * app [Order​App](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderApp) The application that created the order. For example, "Online Store", "Point of Sale", or a custom app name. Use this to identify the order source for attribution and fulfillment workflows. Learn more about [building apps for orders and fulfillment](https://shopify.dev/docs/apps/build/orders-fulfillment). * billing​Address [Mailing​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) The billing address associated with the payment method selected by the customer for an order. Returns `null` if no billing address was provided during checkout. * billing​Address​Matches​Shipping​Address [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the billing address matches the [shipping address](https://shopify.dev/docs/api/admin-graphql/latest/objects/order#field-Order.fields.shippingAddress). Returns `true` if both addresses are the same, and `false` if they're different or if an address is missing. * cancellation [Order​Cancellation](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderCancellation) Details of an order's cancellation, if it has been canceled. This includes the reason, date, and any [staff notes](https://shopify.dev/api/admin-graphql/latest/objects/OrderCancellation#field-OrderCancellation.fields.staffNote). * cancelled​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601) when an order was canceled. Returns `null` if the order hasn't been canceled. * cancel​Reason [Order​Cancel​Reason](https://shopify.dev/docs/api/admin-graphql/latest/enums/OrderCancelReason) The reason provided for an order cancellation. For example, a merchant might cancel an order if there's insufficient inventory. Returns `null` if the order hasn't been canceled. * can​Mark​As​Paid [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether an order can be manually marked as paid. Returns `false` if the order is already paid, is canceled, has pending [Shopify Payments](https://help.shopify.com/en/manual/payments/shopify-payments/payouts) transactions, or has a negative payment amount. * can​Notify​Customer [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether order notifications can be sent to the customer. Returns `true` if the customer has a valid [email address](https://shopify.dev/docs/api/admin-graphql/latest/objects/order#field-Order.fields.email). * capturable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether an authorized payment for an order can be captured. Returns `true` if an authorized payment exists that hasn't been fully captured yet. Learn more about [capturing payments](https://help.shopify.com/en/manual/fulfillment/managing-orders/payments/capturing-payments). * cart​Discount​Amount​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The total discount amount applied at the time the order was created, displayed in both shop and presentment currencies, before returns, refunds, order edits, and cancellations. This field only includes discounts applied to the entire order. * channel​Information [Channel​Information](https://shopify.dev/docs/api/admin-graphql/latest/objects/ChannelInformation) Details about the sales channel that created the order, such as the [channel app type](https://shopify.dev/docs/api/admin-graphql/latest/objects/channel#field-Channel.fields.channelType) and [channel name](https://shopify.dev/docs/api/admin-graphql/latest/objects/ChannelDefinition#field-ChannelDefinition.fields.channelName), which helps to track order sources. * client​Ip [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The IP address of the customer who placed the order. Useful for fraud detection and geographic analysis. * closed [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether an order is closed. An order is considered closed if all its line items have been fulfilled or canceled, and all financial transactions are complete. * closed​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601) when an order was closed. Shopify automatically records this timestamp when all items have been fulfilled or canceled, and all financial transactions are complete. Returns `null` if the order isn't closed. * confirmation​Number [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A customer-facing order identifier, often shown instead of the sequential order name. It uses a random alphanumeric format (for example, `XPAV284CT`) and isn't guaranteed to be unique across orders. * confirmed [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether inventory has been reserved for an order. Returns `true` if inventory quantities for an order's [line items](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItem) have been reserved. Learn more about [managing inventory quantities and states](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states). * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601) when an order was created. This timestamp is set when the customer completes checkout and remains unchanged throughout an order's lifecycle. * currency​Code [Currency​Code!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CurrencyCode) non-null The shop currency when the order was placed. For example, "USD" or "CAD". * current​Cart​Discount​Amount​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The current total of all discounts applied to the entire order, after returns, refunds, order edits, and cancellations. This includes discount codes, automatic discounts, and other promotions that affect the whole order rather than individual line items. To get the original discount amount at the time of order creation, use the [`cartDiscountAmountSet`](https://shopify.dev/docs/api/admin-graphql/latest/objects/order#field-Order.fields.cartDiscountAmountSet) field. * current​Shipping​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The current shipping price after applying refunds and discounts. If the parent `order.taxesIncluded` field is true, then this price includes taxes. Otherwise, this field is the pre-tax price. * current​Subtotal​Line​Items​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The current sum of the quantities for all line items that contribute to the order's subtotal price, after returns, refunds, order edits, and cancellations. * current​Subtotal​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total price of the order, after returns and refunds, in shop and presentment currencies. This includes taxes and discounts. * current​Tax​Lines [\[Tax​Line!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxLine) non-null A list of all tax lines applied to line items on the order, after returns. Tax line prices represent the total price for all tax lines with the same `rate` and `title`. * current​Total​Additional​Fees​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The current total of all additional fees for an order, after any returns or modifications. Modifications include returns, refunds, order edits, and cancellations. Additional fees can include charges such as duties, import fees, and special handling. * current​Total​Discounts​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total amount discounted on the order after returns and refunds, in shop and presentment currencies. This includes both order and line level discounts. * current​Total​Duties​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The current total duties amount for an order, after any returns or modifications. Modifications include returns, refunds, order edits, and cancellations. * current​Total​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total price of the order, after returns, in shop and presentment currencies. This includes taxes and discounts. * current​Total​Tax​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The sum of the prices of all tax lines applied to line items on the order, after returns and refunds, in shop and presentment currencies. * current​Total​Weight [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64) non-null The total weight of the order after returns and refunds, in grams. * custom​Attributes [\[Attribute!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Attribute) non-null A list of additional information that has been attached to the order. For example, gift message, delivery instructions, or internal notes. * customer [Customer](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) The customer who placed an order. Returns `null` if an order was created through a checkout without customer authentication, such as a guest checkout. Learn more about [customer accounts](https://help.shopify.com/manual/customers/customer-accounts). * customer​Accepts​Marketing [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the customer agreed to receive marketing emails at the time of purchase. Use this to ensure compliance with marketing consent laws and to segment customers for email campaigns. Learn more about [building customer segments](https://shopify.dev/docs/apps/build/marketing-analytics/customer-segments). * customer​Journey​Summary [Customer​Journey​Summary](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerJourneySummary) The customer's visits and interactions with the online store before placing the order. Use this to understand customer behavior, attribution sources, and marketing effectiveness to optimize your sales funnel. * customer​Locale [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The customer's language and region preference at the time of purchase. For example, "en" for English, "fr-CA" for French (Canada), or "es-MX" for Spanish (Mexico). Use this to provide localized customer service and targeted marketing in the customer's preferred language. * discount​Applications [Discount​Application​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/DiscountApplicationConnection) non-null A list of discounts that are applied to the order, excluding order edits and refunds. Includes discount codes, automatic discounts, and other promotions that reduce the order total. * after [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * first [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * discount​Code [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The discount code used for an order. Returns `null` if no discount code was applied. * discount​Codes [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The discount codes used for the order. Multiple codes can be applied to a single order. * display​Address [Mailing​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) The primary address of the customer, prioritizing shipping address over billing address when both are available. Returns `null` if neither shipping address nor billing address was provided. * display​Financial​Status [Order​Display​Financial​Status](https://shopify.dev/docs/api/admin-graphql/latest/enums/OrderDisplayFinancialStatus) An order's financial status for display in the Shopify admin. * display​Fulfillment​Status [Order​Display​Fulfillment​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/OrderDisplayFulfillmentStatus) non-null The order's fulfillment status that displays in the Shopify admin to merchants. For example, an order might be unfulfilled or scheduled. For detailed processing, use the [`FulfillmentOrder`](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrder) object. * disputes [\[Order​Dispute​Summary!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderDisputeSummary) non-null A list of payment disputes associated with the order, such as chargebacks or payment inquiries. Disputes occur when customers challenge transactions with their bank or payment provider. * duties​Included [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether duties are included in the subtotal price of the order. Duties are import taxes charged by customs authorities when goods cross international borders. * edited [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the order has had any edits applied. For example, adding or removing line items, updating quantities, or changing prices. * email [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The email address associated with the customer for this order. Used for sending order confirmations, shipping notifications, and other order-related communications. Returns `null` if no email address was provided during checkout. * estimated​Taxes [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether taxes on the order are estimated. This field returns `false` when taxes on the order are finalized and aren't subject to any changes. * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection) non-null A list of events associated with the order. Events track significant changes and activities related to the order, such as creation, payment, fulfillment, and cancellation. * after [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * first [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * query [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A filter made up of terms, connectives, modifiers, and comparators. | comments | boolean | Whether or not to include [comment-events](https://shopify.dev/api/admin-graphql/latest/objects/CommentEvent) in your search, passing `false` will exclude comment-events, any other value will include comment-events. | | | - `false`\ \- `true` | | created\_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | | | - `created_at:>2025-10-21`\ \- `created_at:=1234`\ \- `id:<=1234` | | subject\_type | string | The resource type affected by this event. See [EventSubjectType](https://shopify.dev/api/admin-graphql/latest/enums/EventSubjectType) for possible values. | | | - `PRODUCT_VARIANT`\ \- `PRODUCT`\ \- `COLLECTION` | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax). * action string The action that occured. Example: * `action:create` * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. * sort​Key [Event​Sort​Keys](https://shopify.dev/docs/api/admin-graphql/latest/enums/EventSortKeys) Default:ID Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations). *** * fulfillable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether there are line items that can be fulfilled. This field returns `false` when the order has no fulfillable line items. For a more granular view of the fulfillment status, refer to the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object. * fulfillment​Orders [Fulfillment​Order​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/FulfillmentOrderConnection) non-null A list of [fulfillment orders](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrder) for an order. Each fulfillment order groups [line items](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order#field-Order.fields.lineItems) that are fulfilled together, allowing an order to be processed in parts if needed. * after [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * displayable [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:false If false, all fulfillment orders will be returned. If true, fulfillment orders that are normally hidden from the merchant will be excluded. For example, fulfillment orders that were closed after being combined or moved are hidden. * first [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * query [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable\_values | default\_value | example\_use | | - | - | - | - | - | - | | default | string | Filter by a case-insensitive search of multiple fields | | | | | in a document. | | | - `query=Bob Norman` - `query=title:green hoodie` | | | | assigned\_location\_id | id | | | | | | id | id | Filter by `id` range. | | | - `id:1234` - `id:>=1234` - `id:<=1234` | | status | string | | | | | | updated\_at | time | | | | | | You can apply one or more filters to a query. Learn more about \[Shopify API | | | | | | | search syntax]\(). | | | | | | * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * fulfillments [\[Fulfillment!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Fulfillment) non-null A list of shipments for the order. Fulfillments represent the physical shipment of products to customers. * first [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) ### Arguments Truncate the array result to this size. * query [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Optional query string to filter fulfillments by timestamps. Examples: `created_at:>='2024-05-07T08:37:00Z' updated_at:<'2025-05-07T08:37:00Z'`, `created_at:'2024-05-07T08:37:00Z'` *** * fulfillments​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The total number of fulfillments for the order, including canceled ones. * fully​Paid [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the order has been paid in full. This field returns `true` when the total amount received equals or exceeds the order total. * has​Timeline​Comment [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the merchant has added a timeline comment to the order. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64) non-null The ID of the corresponding resource in the REST Admin API. * line​Items [Line​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/LineItemConnection) non-null A list of the order's line items. Line items represent the individual products and quantities that make up the order. * after [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * first [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * localized​Fields [Localized​Field​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/LocalizedFieldConnection) non-null List of localized fields for the resource. * after [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * country​Codes [\[Country​Code!\]](https://shopify.dev/docs/api/admin-graphql/latest/enums/CountryCode) The country codes of the extensions. * first [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * purposes [\[Localized​Field​Purpose!\]](https://shopify.dev/docs/api/admin-graphql/latest/enums/LocalizedFieldPurpose) The purpose of the extensions. * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * merchant​Business​Entity [Business​Entity!](https://shopify.dev/docs/api/admin-graphql/latest/objects/BusinessEntity) non-null The legal business structure that the merchant operates under for this order, such as an LLC, corporation, or partnership. Used for tax reporting, legal compliance, and determining which business entity is responsible for the order. * merchant​Editable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the order can be edited by the merchant. Returns `false` for orders that can't be modified, such as canceled orders or orders with specific payment statuses. * merchant​Editable​Errors [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A list of reasons why the order can't be edited. For example, canceled orders can't be edited. * merchant​Of​Record​App [Order​App](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderApp) The application acting as the Merchant of Record for the order. The Merchant of Record is responsible for tax collection and remittance. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * key [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) required ### Arguments The key for the metafield. * namespace [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The container the metafield belongs to. If omitted, the app-reserved namespace will be used. *** * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * after [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * first [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * keys [\[String!\]](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) List of keys of metafields in the format `namespace.key`, will be returned in the same format. * last [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * namespace [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The metafield namespace to filter by. If omitted, all metafields are returned. * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The unique identifier for the order that appears on the order page in the Shopify admin and the **Order status** page. For example, "#1001", "EN1001", or "1001-A". This value isn't unique across multiple stores. Use this field to identify orders in the Shopify admin and for order tracking. * net​Payment​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The net payment for the order, based on the total amount received minus the total amount refunded, in shop and presentment currencies. * non​Fulfillable​Line​Items [Line​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/LineItemConnection) non-null A list of line items that can't be fulfilled. For example, tips and fully refunded line items can't be fulfilled. For a more granular view of the fulfillment status, refer to the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object. * after [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * first [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The note associated with the order. Contains additional information or instructions added by merchants or customers during the order process. Commonly used for special delivery instructions, gift messages, or internal processing notes. * number [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The order number used to generate the name using the store's configured order number prefix/suffix. This number isn't guaranteed to follow a consecutive integer sequence (e.g. 1, 2, 3..), nor is it guaranteed to be unique across multiple stores, or even for a single store. * original​Total​Additional​Fees​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The total amount of all additional fees, such as import fees or taxes, that were applied when an order was created. Returns `null` if additional fees aren't applicable. * original​Total​Duties​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The total amount of duties calculated when an order was created, before any modifications. Modifications include returns, refunds, order edits, and cancellations. Use [`currentTotalDutiesSet`](https://shopify.dev/docs/api/admin-graphql/latest/objects/order#field-Order.fields.currentTotalDutiesSet) to retrieve the current duties amount after adjustments. * original​Total​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total price of the order at the time of order creation, in shop and presentment currencies. Use this to compare the original order value against the current total after edits, returns, or refunds. * payment​Collection​Details [Order​Payment​Collection​Details!](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderPaymentCollectionDetails) non-null The payment collection details for the order, including payment status, outstanding amounts, and collection information. Use this to understand when and how payments should be collected, especially for orders with deferred or installment payment terms. * payment​Gateway​Names [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A list of the names of all payment gateways used for the order. For example, "Shopify Payments" and "Cash on Delivery (COD)". * payment​Terms [Payment​Terms](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentTerms) The payment terms associated with the order, such as net payment due dates or early payment discounts. Payment terms define when and how an order should be paid. Returns `null` if no specific payment terms were set for the order. * phone [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The phone number associated with the customer for this order. Useful for contacting customers about shipping updates, delivery notifications, or order issues. Returns `null` if no phone number was provided during checkout. * po​Number [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The purchase order (PO) number that's associated with an order. This is typically provided by business customers who require a PO number for their procurement. * presentment​Currency​Code [Currency​Code!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CurrencyCode) non-null The currency used by the customer when placing the order. For example, "USD", "EUR", or "CAD". This may differ from the shop's base currency when serving international customers or using multi-currency pricing. * processed​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601) when the order was processed. This date and time might not match the date and time when the order was created. * product​Network [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the customer also purchased items from other stores in the network. * publication [Publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) The sales channel that the order was created from, such as the [Online Store](https://shopify.dev/docs/apps/build/app-surfaces#online-store) or [Shopify POS](https://shopify.dev/docs/apps/build/app-surfaces#point-of-sale). * purchasing​Entity [Purchasing​Entity](https://shopify.dev/docs/api/admin-graphql/latest/unions/PurchasingEntity) The business entity that placed the order, including company details and purchasing relationships. Used for B2B transactions to track which company or organization is responsible for the purchase and payment terms. * refundable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the order can be refunded based on its payment transactions. Returns `false` for orders with no eligible payment transactions, such as fully refunded orders or orders with non-refundable payment methods. * refund​Discrepancy​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The difference between the suggested and actual refund amount of all refunds that have been applied to the order. A positive value indicates a difference in the merchant's favor, and a negative value indicates a difference in the customer's favor. * refunds [\[Refund!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Refund) non-null A list of refunds that have been applied to the order. Refunds represent money returned to customers for returned items, cancellations, or adjustments. * first [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) ### Arguments Truncate the array result to this size. *** * registered​Source​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) The URL of the source that the order originated from, if found in the domain registry. Returns `null` if the source URL isn't in the domain registry. * requires​Shipping [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the order requires physical shipping to the customer. Returns `false` for digital-only orders (such as gift cards or downloadable products) and `true` for orders with physical products that need delivery. Use this to determine shipping workflows and logistics requirements. * restockable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether any line items on the order can be restocked into inventory. Returns `false` for digital products, custom items, or items that can't be resold. * retail​Location [Location](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) The physical location where a retail order is created or completed, except for draft POS orders completed using the "mark as paid" flow in the Shopify admin, which return `null`. Transactions associated with the order might have been processed at a different location. * returns [Return​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ReturnConnection) non-null The returns associated with the order. Contains information about items that customers have requested to return, including return reasons, status, and refund details. Use this to track and manage the return process for order items. * after [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * first [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * query [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax). * * id id * status string - Filter by `id` range. - Example: * `id:1234` * `id:>=1234` * `id:<=1234` * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * return​Status [Order​Return​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/OrderReturnStatus) non-null The order's aggregated return status for display purposes. Indicates the overall state of returns for the order, helping merchants track and manage the return process. * risk [Order​Risk​Summary!](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderRiskSummary) non-null The risk assessment summary for the order. Provides fraud analysis and risk scoring to help you identify potentially fraudulent orders. Use this to make informed decisions about order fulfillment and payment processing. * shipping​Address [Mailing​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) The shipping address where the order will be delivered. Contains the customer's delivery location for fulfillment and shipping label generation. Returns `null` for digital orders or orders that don't require shipping. * shipping​Line [Shipping​Line](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShippingLine) A summary of all shipping costs on the order. Aggregates shipping charges, discounts, and taxes to provide a single view of delivery costs. * shipping​Lines [Shipping​Line​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ShippingLineConnection) non-null The shipping methods applied to the order. Each shipping line represents a shipping option chosen during checkout, including the carrier, service level, and cost. Use this to understand shipping charges and delivery options for the order. * after [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * first [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * include​Removals [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:false Whether results should contain removed shipping lines. * last [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * shopify​Protect [Shopify​Protect​Order​Summary](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyProtectOrderSummary) The Shopify Protect details for the order, including fraud protection status and coverage information. Shopify Protect helps protect eligible orders against fraudulent chargebacks. Returns `null` if Shopify Protect is disabled for the shop or the order isn't eligible for protection. Learn more about [Shopify Protect](https://www.shopify.com/protect). * source​Identifier [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A unique POS or third party order identifier. For example, "1234-12-1000" or "111-98567-54". The [`receiptNumber`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order#field-receiptNumber) field is derived from this value for POS orders. * source​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the source associated with the order, such as "web", "mobile\_app", or "pos". Use this field to identify the platform where the order was placed. * staff​Member [Staff​Member](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) The staff member who created or is responsible for the order. Useful for tracking which team member handled phone orders, manual orders, or order modifications. Returns `null` for orders created directly by customers through the online store. * status​Page​Url [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-null The URL where customers can check their order's current status, including tracking information and delivery updates. Provides order tracking links in emails, apps, or customer communications. * audience [Audience](https://shopify.dev/docs/api/admin-graphql/latest/enums/Audience) ### Arguments Specifies the intended audience for the status page URL. * notification​Usage [Notification​Usage](https://shopify.dev/docs/api/admin-graphql/latest/enums/NotificationUsage) Specifies the intended notification usage for the status page URL. *** * subtotal​Line​Items​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The sum of quantities for all line items that contribute to the order's subtotal price. This excludes quantities for items like tips, shipping costs, or gift cards that don't affect the subtotal. Use this to quickly understand the total item count for pricing calculations. * subtotal​Price​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The sum of the prices for all line items after discounts and before returns, in shop and presentment currencies. If `taxesIncluded` is `true`, then the subtotal also includes tax. * suggested​Refund [Suggested​Refund](https://shopify.dev/docs/api/admin-graphql/latest/objects/SuggestedRefund) A calculated refund suggestion for the order based on specified line items, shipping, and duties. Use this to preview refund amounts, taxes, and processing fees before creating an actual refund. * refund​Duties [\[Refund​Duty​Input!\]](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/RefundDutyInput) ### Arguments The duties from the order to include in the refund. * refund​Line​Items [\[Refund​Line​Item​Input!\]](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/RefundLineItemInput) The line items from the order to include in the refund. * refund​Method​Allocation [Refund​Method​Allocation](https://shopify.dev/docs/api/admin-graphql/latest/enums/RefundMethodAllocation) Default:ORIGINAL\_PAYMENT\_METHODS Specifies which refund methods to allocate the suggested refund amount to. * refund​Shipping [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Whether to refund the full shipping amount. * shipping​Amount [Money](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) The amount to refund for shipping. Overrides the `refundShipping` argument. * suggest​Full​Refund [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:false Whether the suggested refund should be created from all refundable line items on the order. If `true`, the `refundLineItems` argument will be ignored. *** * tags [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A comma separated list of tags associated with the order. Updating `tags` overwrites any existing tags that were previously added to the order. To add new tags without overwriting existing tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) mutation. * taxes​Included [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether taxes are included in the subtotal price of the order. When `true`, the subtotal and line item prices include tax amounts. When `false`, taxes are calculated and displayed separately. * tax​Exempt [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether taxes are exempt on the order. Returns `true` for orders where the customer or business has a valid tax exemption, such as non-profit organizations or tax-free purchases. Use this to understand if tax calculations were skipped during checkout. * tax​Lines [\[Tax​Line!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxLine) non-null A list of all tax lines applied to line items on the order, before returns. Tax line prices represent the total price for all tax lines with the same `rate` and `title`. * test [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the order is a test. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. A test order can't be converted into a real order and vice versa. * total​Capturable​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The authorized amount that's uncaptured or undercaptured, in shop and presentment currencies. This amount isn't adjusted for returns. * total​Cash​Rounding​Adjustment [Cash​Rounding​Adjustment!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CashRoundingAdjustment) non-null The total rounding adjustment applied to payments or refunds for an order involving cash payments. Applies to some countries where cash transactions are rounded to the nearest currency denomination. * total​Discounts​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The total amount discounted on the order before returns, in shop and presentment currencies. This includes both order and line level discounts. * total​Outstanding​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total amount not yet transacted for the order, in shop and presentment currencies. A positive value indicates a difference in the merchant's favor (payment from customer to merchant) and a negative value indicates a difference in the customer's favor (refund from merchant to customer). * total​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total price of the order, before returns, in shop and presentment currencies. This includes taxes and discounts. * total​Received​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total amount received from the customer before returns, in shop and presentment currencies. * total​Refunded​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total amount that was refunded, in shop and presentment currencies. * total​Refunded​Shipping​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total amount of shipping that was refunded, in shop and presentment currencies. * total​Shipping​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total shipping costs returned to the customer, in shop and presentment currencies. This includes fees and any related discounts that were refunded. * total​Tax​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The total tax amount before returns, in shop and presentment currencies. * total​Tip​Received​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The sum of all tip amounts for the order, in shop and presentment currencies. * total​Weight [Unsigned​Int64](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64) The total weight of the order before returns, in grams. * transactions [\[Order​Transaction!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderTransaction) non-null A list of transactions associated with the order. * capturable [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) ### Arguments Filter transactions by whether they are capturable. * first [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) Truncate the array result to this size. * manually​Resolvable [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Filter transactions by whether they can be resolved manually. For example, fully captured or voided transactions aren't manually resolvable. *** * transactions​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The number of transactions associated with the order. * unpaid [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether no payments have been made for the order. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601) when the order was last modified. ### Deprecated fields * cart​Discount​Amount [Money](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) Deprecated * channel [Channel](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel) Deprecated * customer​Journey [Customer​Journey](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerJourney) Deprecated * exchange​V2s [Exchange​V2Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ExchangeV2Connection) non-nullDeprecated * after [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * first [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * query [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax). * completed\_at time * * id id * include\_mirrored\_exchanges boolean - Filter by `id` range. - Example: * `id:1234` * `id:>=1234` * `id:<=1234` * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * landing​Page​Display​Text [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * landing​Page​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) Deprecated * localization​Extensions [Localization​Extension​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/LocalizationExtensionConnection) non-nullDeprecated * after [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * country​Codes [\[Country​Code!\]](https://shopify.dev/docs/api/admin-graphql/latest/enums/CountryCode) The country codes of the extensions. * first [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * purposes [\[Localization​Extension​Purpose!\]](https://shopify.dev/docs/api/admin-graphql/latest/enums/LocalizationExtensionPurpose) The purpose of the extensions. * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * after [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * first [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * namespace [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Filter metafield definitions by namespace. * pinned​Status [Metafield​Definition​Pinned​Status](https://shopify.dev/docs/api/admin-graphql/latest/enums/MetafieldDefinitionPinnedStatus) Default:ANY Filter by the definition's pinned status. * query [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable\_values | default\_value | example\_use | | - | - | - | - | - | - | | default | string | Filter by a case-insensitive search of multiple fields | | | | | in a document. | | | - `query=Bob Norman` - `query=title:green hoodie` | | | | created\_at | time | Filter by the date and time when the metafield | | | | | definition was created. | | | - `created_at:>2020-10-21T23:39:20Z` - | | | | `created_at:=1234` - `id:<=1234` | | key | string | Filter by the metafield definition [`key`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-key) | | | | | field. | | | - `key:some-key` | | | | namespace | string | Filter by the metafield definition [`namespace`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-namespace) | | | | | field. | | | - `namespace:some-namespace` | | | | owner\_type | string | Filter by the metafield definition [`ownerType`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-ownertype) | | | | | field. | | | - `owner_type:PRODUCT` | | | | type | string | Filter by the metafield definition [`type`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-type) | | | | | field. | | | - `type:single_line_text_field` | | | | updated\_at | time | Filter by the date and time when the metafield | | | | | definition was last updated. | | | - `updated_at:>2020-10-21T23:39:20Z` | | | * `updated_at:=5.00 | | | | | | | current\_total\_price:<=20.99\` | | | | | | | customer\_id | id | Filter orders by the customer [`id`](https://shopify.dev/api/admin-graphql/latest/objects/Customer#field-Customer.fields.id) | | | | | field. | | | - `customer_id:123` | | | | delivery\_method | string | Filter by the delivery [`methodType`](https://shopify.dev/api/admin-graphql/2024-07/objects/DeliveryMethod#field-DeliveryMethod.fields.methodType) | | | | | field. | - `shipping` - `pick-up` - `retail` - `local` - | | | | | | `pickup-point` - `none` | | - `delivery_method:shipping` | | | | | discount\_code | string | Filter by the case-insensitive discount code that | | | | | was applied to the order at checkout. Limited to the first discount code | | | | | | | used on an order. Maximum characters: 255. | | | - `discount_code:ABC123` | | | | email | string | Filter by the email address that's associated with the | | | | | order to provide customer support or analyze purchasing patterns. | | | - | | | | `email:example@shopify.com` | | | | | | | financial\_status | string | Filter by the order [`displayFinancialStatus`](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-Order.fields.displayFinancialStatus) | | | | | field. | - `paid` - `pending` - `authorized` - | | | | | | `partially_paid` - `partially_refunded` - `refunded` - | | | | | | | `voided` - `expired` | | - `financial_status:authorized` | | | | | fraud\_protection\_level | string | Filter by the level of fraud protection | | | | | that's applied to the order. Use this filter to manage risk or handle | | | | | | | disputes. | - `fully_protected` - `partially_protected` - | | | | | | `not_protected` - `pending` - `not_eligible` - | | | | | | | `not_available` | | - `fraud_protection_level:fully_protected` | | | | | fulfillment\_location\_id | id | Filter by the fulfillment location [`id`](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment#field-Fulfillment.fields.location.id) | | | | | (`Fulfillment.location.id`) field. | | | - `fulfillment_location_id:123` | | | | fulfillment\_status | string | Filter by the [`displayFulfillmentStatus`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order#field-Order.fields.displayFulfillmentStatus) | | | | | field to prioritize shipments or monitor order processing. | - | | | | | | `unshipped` - `shipped` - `fulfilled` - `partial` - | | | | | | | `scheduled` - `on_hold` - `unfulfilled` - `request_declined` | | | | | | | | - `fulfillment_status:fulfilled` | | | | | | gateway | string | Filter by the [`paymentGatewayNames`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order#field-Order.fields.paymentGatewayNames) | | | | | field. Use this filter to find orders that were processed through specific | | | | | | | payment providers like Shopify Payments, PayPal, or other custom payment | | | | | | | gateways. | | | - `gateway:shopify_payments` | | | | id | id | Filter by `id` range. | | | - `id:1234` - `id:>=1234` - `id:<=1234` | | location\_id | id | Filter by the location [`id`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location#field-Location.fields.id) | | | | | that's associated with the order to view and manage orders for specific | | | | | | | locations. For POS orders, locations must be defined in the Shopify admin | | | | | | | under **Settings** > **Locations**. If no ID is provided, then the primary | | | | | | | location of the shop is returned. | | | - `location_id:123` | | | | metafields.{namespace}.{key} | mixed | Filters resources by metafield | | | | | value. Format: `metafields.{namespace}.{key}:{value}`. Learn more about | | | | | | | [querying by metafield value](https://shopify.dev/apps/build/custom-data/metafields/query-by-metafield-value). | | | | | | | | | - `metafields.custom.on_sale:true` - | | | | | `metafields.product.material:"gid://shopify/Metaobject/43458085"` | | | | | | | name | string | Filter by the order [`name`](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-name) | | | | | field. | | | - `name:1001-A` | | | | payment\_id | string | Filter by the payment ID that's associated with the | | | | | order to reconcile financial records or troubleshoot payment issues. | | | - | | | | `payment_id:abc123` | | | | | | | payment\_provider\_id | id | Filter by the ID of the payment provider that's | | | | | associated with the order to manage payment methods or troubleshoot | | | | | | | transactions. | | | - `payment_provider_id:123` | | | | po\_number | string | Filter by the order [`poNumber`](https://shopify.dev/api/admin-graphql/latest/objects/order#field-Order.fields.poNumber) | | | | | field. | | | - `po_number:P01001` | | | | processed\_at | time | Filter by the order [`processedAt`](https://shopify.dev/api/admin-graphql/latest/objects/order#field-Order.fields.processedAt) | | | | | field. | | | - `processed_at:2021-01-01T00:00:00Z` | | | | reference\_location\_id | id | Filter by the ID of a location that's | | | | | associated with the order, such as locations from fulfillments, refunds, or | | | | | | | the shop's primary location. | | | - `reference_location_id:123` | | | | return\_status | string | Filter by the order's [`returnStatus`](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-Order.fields.returnStatus) | | | | | to monitor returns processing and track which orders have active returns. | | | | | | * `return_requested`\ \- `in_progress`\ \- `inspection_complete` * `returned`\ \- `return_failed`\ \- `no_return` | | - `return_status:in_progress` | | risk\_level | string | Filter by the order risk assessment [`riskLevel`](https://shopify.dev/api/admin-graphql/latest/objects/OrderRiskAssessment#field-OrderRiskAssessment.fields.riskLevel) field. | - `high`\ \- `medium`\ \- `low`\ \- `none`\ \- `pending` | | - `risk_level:high` | | sales\_channel | string | Filter by the [sales channel](https://shopify.dev/docs/apps/build/sales-channels) where the order was made to analyze performance or manage fulfillment processes. | | | - `sales_channel: some_sales_channel` | | sku | string | Filter by the product variant [`sku`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-ProductVariant.fields.sku) field. [Learn more about SKUs](https://help.shopify.com/manual/products/details/sku). | | | - `sku:ABC123` | | source\_identifier | string | Filter by the ID of the order placed on the originating platform, such as a unique POS or third-party identifier. This value doesn't correspond to the Shopify ID that's generated from a completed draft order. | | | - `source_identifier:1234-12-1000` | | source\_name | string | Filter by the platform where the order was placed to distinguish between web orders, POS sales, draft orders, or third-party channels. Use this filter to analyze sales performance across different ordering methods. | | | - `source_name:web`\ \- `source_name:shopify_draft_order` | | status | string | Filter by the order's status to manage workflows or analyze the order lifecycle. | - `open`\ \- `closed`\ \- `cancelled`\ \- `not_closed` | | - `status:open` | | subtotal\_line\_items\_quantity | string | Filter by the total number of items across all line items in an order. This filter supports both exact values and ranges, and is useful for identifying bulk orders or analyzing purchase volume patterns. | | | - `subtotal_line_items_quantity:10`\ \- `subtotal_line_items_quantity:5..20` | | tag | string | Filter objects by the `tag` field. | | | - `tag:my_tag` | | tag\_not | string | Filter by objects that don’t have the specified tag. | | | - `tag_not:my_tag` | | test | boolean | Filter by test orders. Test orders are made using the [Shopify Bogus Gateway](https://help.shopify.com/manual/checkout-settings/test-orders/payments-test-mode#bogus-gateway) or a payment provider with test mode enabled. | | | - `test:true` | | total\_weight | string | Filter by the order weight. This filter supports both exact values and ranges, and is to be used to filter orders by the total weight of all items (excluding packaging). It takes a unit of measurement as a suffix. It accepts the following units: g, kg, lb, oz. | | | - `total_weight:10.5kg`\ \- `total_weight:>=5g total_weight:<=20g` * `total_weight:.5 lb` | | updated\_at | time | Filter by the date and time when the order was last updated in Shopify's system. | | | - `updated_at:2020-10-21T23:39:20Z` * `updated_at:\order\Create\\ mutation with a \trial\ or \development store\, then you can create a maximum of five new orders per minute. *** After you create an order, you can make subsequent edits to the order using one of the following mutations: * [`orderUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderUpdate): Used for simple updates to an order, such as changing the order's note, tags, or customer information. * [`orderEditBegin`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditBegin): Used when you need to make significant updates to an order, such as adding or removing line items, changing quantities, or modifying discounts. The `orderEditBegin` mutation initiates an order editing session, allowing you to make multiple changes before finalizing them. Learn more about using the `orderEditBegin` mutation to [edit existing orders](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps/edit-orders). Learn how to build apps that integrate with [order management and fulfillment processes](https://shopify.dev/docs/apps/build/orders-fulfillment). * options [Order​Create​Options​Input](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/OrderCreateOptionsInput) ### Arguments The strategies for updating inventory and whether to send shipping and order confirmations to customers. * order [Order​Create​Order​Input!](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/OrderCreateOrderInput) required The attributes of the new order. *** * [order​Create​Manual​Payment](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCreateManualPayment) mutation Records a manual payment for an [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) that isn't fully paid. Use this mutation to track payments received outside the standard checkout process, such as cash, check, bank transfer, or other offline payment methods. You can specify the payment [amount](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCreateManualPayment#arguments-amount), [method name](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCreateManualPayment#arguments-paymentMethodName), and [when it was processed](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCreateManualPayment#arguments-processedAt). * amount [Money​Input](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/MoneyInput) ### Arguments The manual payment amount to be created. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required The ID of the order to create a manual payment for. * payment​Method​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the payment method used for creating the payment. If none is provided, then the default manual payment method ('Other') will be used. * processed​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when a manual payment was processed. If you're importing transactions from an app or another platform, then you can set processedAt to a date and time in the past to match when the original transaction was created. *** * [order​Customer​Remove](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCustomerRemove) mutation Removes customer from an order. * order​Id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required ### Arguments The ID of the order having its customer removed. *** * [order​Customer​Set](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCustomerSet) mutation Sets a customer on an order. * customer​Id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required ### Arguments The ID of the customer being set on the order. * order​Id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required The ID of the order having a customer set. *** * [order​Edit​Commit](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditCommit) mutation Applies staged changes from an order editing session to the original order. This finalizes all modifications made during the edit session, including changes to line items, quantities, discounts, and shipping lines. Order editing follows a three-step workflow: start with [`orderEditBegin`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditBegin) to create an editing session, apply changes using various orderEdit mutations, and then save the changes with the [`orderEditCommit`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditCommit) mutation. The mutation can optionally notify the customer of changes and add staff notes for internal tracking. You can only edit unfulfilled line items. If an edit changes the total order value, then the customer might need to pay a balance or receive a refund. Learn more about [editing existing orders](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps/edit-orders). * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required ### Arguments The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder) or the order edit session that will have its changes applied to the order. * notify​Customer [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Whether to notify the customer or not. * staff​Note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Note for staff members. *** * [order​Invoice​Send](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderInvoiceSend) mutation Sends an email invoice for an [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order). You can customize the email recipient, sender, and subject line using the [`email`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderInvoiceSend#arguments-email) argument. *** **Note:** Use store or staff account email addresses for the \\from\\ and \\bcc\\ input fields. *** * email [Email​Input](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/EmailInput) ### Arguments The email input fields for the order invoice. The `bcc` and `from` fields should be store or staff account emails. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required The order associated with the invoice. *** * [order​Mark​As​Paid](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderMarkAsPaid) mutation Marks an order as paid by recording a payment transaction for the outstanding amount. Use the `orderMarkAsPaid` mutation to record payments received outside the standard checkout process. The `orderMarkAsPaid` mutation is particularly useful in scenarios where: * Orders were created with manual payment methods (cash on delivery, bank deposit, money order) * Payments were received offline and need to be recorded in the system * Previously authorized payments need to be captured manually * Orders require manual payment reconciliation due to external payment processing The mutation validates that the order can be marked as paid before processing. An order can be marked as paid only if it has a positive outstanding balance and its [financial status](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order#field-Order.fields.displayFinancialStatus) isn't already `PAID`. The mutation will either create a new sale transaction for the full outstanding amount or capture an existing authorized transaction, depending on the order's current payment state. After successfully marking an order as paid, the order's financial status is updated to reflect the payment, and payment events are logged for tracking and analytics purposes. Learn more about [managing orders](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps) in apps. * input [Order​Mark​As​Paid​Input!](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/OrderMarkAsPaidInput) required ### Arguments The input for the mutation. *** * [order​Open](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderOpen) mutation Opens a closed order. * input [Order​Open​Input!](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/OrderOpenInput) required ### Arguments The input for the mutation. *** * [order​Update](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderUpdate) mutation Updates the attributes of an order, such as the customer's email, the shipping address for the order, tags, and [metafields](https://shopify.dev/docs/apps/build/custom-data) associated with the order. If you need to make significant updates to an order, such as adding or removing line items, changing quantities, or modifying discounts, then use the [`orderEditBegin`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditBegin) mutation instead. The `orderEditBegin` mutation initiates an order editing session, allowing you to make multiple changes before finalizing them. Learn more about using the `orderEditBegin` mutation to [edit existing orders](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps/edit-orders). If you need to remove a customer from an order, then use the [`orderCustomerRemove`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCustomerRemove) mutation instead. Learn how to build apps that integrate with [order management and fulfillment processes](https://shopify.dev/docs/apps/build/orders-fulfillment). * input [Order​Input!](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/OrderInput) required ### Arguments The attributes of the updated order. *** * [refund​Create](https://shopify.dev/docs/api/admin-graphql/latest/mutations/refundCreate) mutation Creates a refund for an order, allowing you to process returns and issue payments back to customers. Use the `refundCreate` mutation to programmatically process refunds in scenarios where you need to return money to customers, such as when handling returns, processing chargebacks, or correcting order errors. The `refundCreate` mutation supports various refund scenarios: * Refunding line items with optional restocking * Refunding shipping costs * Refunding duties and import taxes * Refunding additional fees * Processing refunds through different payment methods * Issuing store credit refunds (when enabled) You can create both full and partial refunds, and optionally allow over-refunding in specific cases. After creating a refund, you can track its status and details through the order's [`refunds`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order#field-Order.fields.refunds) field. The refund is associated with the order and can be used for reporting and reconciliation purposes. Learn more about [managing returns](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/build-return-management) and [refunding duties](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/view-and-refund-duties). *** **Note:** The refunding behavior of the \\refund\Create\\ mutation is similar to the \\\refund\Return\\\ mutation. The key difference is that the \\refund\Create\\ mutation lets you to specify restocking behavior for line items, whereas the \\return\Refund\\ mutation focuses solely on handling the financial refund without any restocking input. *** *** **Caution:** As of 2026-01, this mutation supports an optional idempotency key using the \@idempotent\ directive. As of 2026-04, the idempotency key is required and must be provided using the \@idempotent\ directive. For more information, see the \idempotency documentation\. *** * input [Refund​Input!](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/RefundInput) required ### Arguments The input fields that are used in the mutation for creating a refund. *** * [tax​Summary​Create](https://shopify.dev/docs/api/admin-graphql/latest/mutations/taxSummaryCreate) mutation Creates a tax summary for a given order. If both an order ID and a start and end time are provided, the order ID will be used. * end​Time [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) ### Arguments The end time of the range of orders to create the tax summary for. * order​Id [ID](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) The ID of the order to create the tax summary for. * start​Time [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The start time of the range of orders to create the tax summary for. *** *** ## Order Mutations ### Mutated by * [order​Close](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderClose) * [order​Create](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCreate) * [order​Create​Manual​Payment](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCreateManualPayment) * [order​Customer​Remove](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCustomerRemove) * [order​Customer​Set](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCustomerSet) * [order​Edit​Commit](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditCommit) * [order​Invoice​Send](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderInvoiceSend) * [order​Mark​As​Paid](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderMarkAsPaid) * [order​Open](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderOpen) * [order​Update](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderUpdate) * [refund​Create](https://shopify.dev/docs/api/admin-graphql/latest/mutations/refundCreate) * [tax​Summary​Create](https://shopify.dev/docs/api/admin-graphql/latest/mutations/taxSummaryCreate) *** ## Interfaces * * [Comment​Event​Subject](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/CommentEventSubject) interface * [Has​Events](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/HasEvents) interface * [Has​Localization​Extensions](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/HasLocalizationExtensions) interface * [Has​Localized​Fields](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/HasLocalizedFields) interface * [Has​Metafield​Definitions](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/HasMetafieldDefinitions) interface * [Has​Metafields](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/HasMetafields) interface * [Legacy​Interoperability](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/LegacyInteroperability) interface * [Node](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Node) interface *** ## Order Implements ### Implements * [Comment​Event​Subject](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/CommentEventSubject) * [Has​Events](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/HasEvents) * [Has​Localization​Extensions](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/HasLocalizationExtensions) * [Has​Localized​Fields](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/HasLocalizedFields) * [Has​Metafield​Definitions](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/HasMetafieldDefinitions) * [Has​Metafields](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/HasMetafields) * [Legacy​Interoperability](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/LegacyInteroperability) * [Node](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Node)