9/11/2026, 12:00:15 AM
The GraphQL schema now exposes brand‑related objects (BrandingBrand, BrandingBrandColors, BrandingBrandImage, BrandingBrandLogo, BrandImageAssetType and BrandingColorGroup) so apps can read and update shop branding settings. Branded fields include colors, cover images, and logos with optional ‘assetType’ selections. The requested order edit mutations have been clarified: requestedOrderEditCreate, requestedOrderEditDecline and requestedOrderEditResolve now have descriptions that explicitly reference an "order". The input objects for those mutations remain unchanged; only the wording was updated. Query arguments for orders and ordersCount keep the same filter syntax and description but have been formally recorded as modified to reflect minor description updates. No new fields have been added or removed in core queries; the primary change is the richer branding API and clearer mutation descriptions for requested edits.
Returns a list of orders placed in the store, including data such as order status, customer, and line item details.
Use the orders query to build reports, analyze sales performance, or automate fulfillment workflows. The orders query supports pagination,
sorting, and filtering.
Returns the number of orders in the shop. You can filter orders using search syntax or a SavedSearch, and set a maximum count limit to control query performance.
Use the query argument to filter the count by criteria like order status, financial state, or fulfillment status. The response includes both the count value and its precision, indicating whether the count is exact or an estimate.
Note:
The count is limited to 10,000 orders by default. Use thelimitargument to adjust this value, or passnullfor no limit. Limited to a maximum of 10000 by default.
Creates a requested order edit on an order on behalf of a buyer.
Declines a requested order edit on an order.
Resolves a requested order edit on an order, marking it as completed.
The type of asset for the shop brand images.
The brand settings for the shop.
The brand colors for the shop brand settings.
The brand images for the shop brand settings.
The brand images that are used as logos for the shop brand settings.
A container for a color palette.
lineItemslineItems on CalculatedRequestedOrderEditThe line item changes being processed for an edit, grouped by the type of change.
CalculatedRequestedOrderEditLineItems!The line item changes being processed for a requested order edit, grouped by the type of change.
CalculatedRequestedOrderEditLineItems!lineItemlineItem on CalculatedRequestedOrderEditLineItemThe line item being processed for an edit.
LineItem!The line item being processed for a requested order edit.
LineItem!ordersorders on CompanyThe list of the company's orders.
OrderConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: OrderSortKeys - 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.
query: 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 |
||
| cart_token | string | Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order. | - cart_token:abc123 |
||
| channel | string | Filter by the order attribution handle (Order.attribution.handle) field. The legacy channel information handle (ChannelInformation.channelDefinition.handle) field is deprecated but remains supported during the deprecation period. |
- channel:web- channel:web,pos |
||
| channel_id | id | Filter by the channel id field. |
- channel_id:123 |
||
| chargeback_status | string | Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution. | - accepted- charge_refunded- lost- needs_response- under_review- won |
- chargeback_status:accepted |
|
| checkout_token | string | Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order. | - checkout_token:abc123 |
||
| confirmation_number | string | Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique. | - confirmation_number:ABC123 |
||
| created_at | time | Filter by the date and time when the order was created in Shopify's system. | - created_at:'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| credit_card_last4 | string | Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security. | - credit_card_last4:1234 |
||
| current_total_price | float | Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges. | - current_total_price:10- current_total_price:>=5.00 current_total_price:<=20.99 |
||
| customer_id | id | Filter orders by the customer id field. |
- customer_id:123 |
||
| delivery_method | string | Filter by the delivery 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 |
||
| 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 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 (Fulfillment.location.id) field. |
- fulfillment_location_id:123 |
||
| fulfillment_status | string | Filter by the 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 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 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. |
- metafields.custom.on_sale:true- metafields.product.material:"gid://shopify/Metaobject/43458085" |
||
| name | string | Filter by the order 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 field. |
- po_number:P01001 |
||
| processed_at | time | Filter by the order 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 |
||
| requested_order_edit_status | string | Filter by the order's displayRequestedEditStatus to track which orders have buyer-initiated requested edits pending merchant action. |
- none- requested- resolved- denied |
- requested_order_edit_status:requested |
|
| return_status | string | Filter by the order's 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 field. |
- high- medium- low- none- pending |
- risk_level:high |
|
| sales_channel | string | Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes. | - sales_channel: some_sales_channel |
||
| shipping_address_validation_result_summary | string | Filter by the validation status of the shipping address. Learn more about validating addresses. | - has_issues- no_issues- not_validated |
- shipping_address_validation_result_summary:no_issues |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- 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 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:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The list of the company's orders.
OrderConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: OrderSortKeys - 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.
query: 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 |
||
| cart_token | string | Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order. | - cart_token:abc123 |
||
| channel | string | Filter by the order attribution handle (Order.attribution.handle) field. The legacy channel information handle (ChannelInformation.channelDefinition.handle) field is deprecated but remains supported during the deprecation period. |
- channel:web- channel:web,pos |
||
| channel_id | id | Filter by the channel id field. |
- channel_id:123 |
||
| chargeback_status | string | Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution. | - accepted- charge_refunded- lost- needs_response- under_review- won |
- chargeback_status:accepted |
|
| checkout_token | string | Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order. | - checkout_token:abc123 |
||
| confirmation_number | string | Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique. | - confirmation_number:ABC123 |
||
| created_at | time | Filter by the date and time when the order was created in Shopify's system. | - created_at:'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| credit_card_last4 | string | Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security. | - credit_card_last4:1234 |
||
| current_total_price | float | Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges. | - current_total_price:10- current_total_price:>=5.00 current_total_price:<=20.99 |
||
| customer_id | id | Filter orders by the customer id field. |
- customer_id:123 |
||
| delivery_method | string | Filter by the delivery 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 |
||
| 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 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 (Fulfillment.location.id) field. |
- fulfillment_location_id:123 |
||
| fulfillment_status | string | Filter by the 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 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 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. |
- metafields.custom.on_sale:true- metafields.product.material:"gid://shopify/Metaobject/43458085" |
||
| name | string | Filter by the order 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 field. |
- po_number:P01001 |
||
| processed_at | time | Filter by the order 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 |
||
| requested_order_edit_status | string | Filter by the order's displayRequestedEditStatus to track which orders have buyer-initiated requested order edits pending merchant action. |
- none- requested- resolved- declined |
- requested_order_edit_status:requested |
|
| return_status | string | Filter by the order's 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 field. |
- high- medium- low- none- pending |
- risk_level:high |
|
| sales_channel | string | Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes. | - sales_channel: some_sales_channel |
||
| shipping_address_validation_result_summary | string | Filter by the validation status of the shipping address. Learn more about validating addresses. | - has_issues- no_issues- not_validated |
- shipping_address_validation_result_summary:no_issues |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- 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 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:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
ordersorders on CustomerA list of the customer's orders.
OrderConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: OrderSortKeys - 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.
query: 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 |
||
| cart_token | string | Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order. | - cart_token:abc123 |
||
| channel | string | Filter by the order attribution handle (Order.attribution.handle) field. The legacy channel information handle (ChannelInformation.channelDefinition.handle) field is deprecated but remains supported during the deprecation period. |
- channel:web- channel:web,pos |
||
| channel_id | id | Filter by the channel id field. |
- channel_id:123 |
||
| chargeback_status | string | Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution. | - accepted- charge_refunded- lost- needs_response- under_review- won |
- chargeback_status:accepted |
|
| checkout_token | string | Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order. | - checkout_token:abc123 |
||
| confirmation_number | string | Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique. | - confirmation_number:ABC123 |
||
| created_at | time | Filter by the date and time when the order was created in Shopify's system. | - created_at:'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| credit_card_last4 | string | Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security. | - credit_card_last4:1234 |
||
| current_total_price | float | Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges. | - current_total_price:10- current_total_price:>=5.00 current_total_price:<=20.99 |
||
| customer_id | id | Filter orders by the customer id field. |
- customer_id:123 |
||
| delivery_method | string | Filter by the delivery 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 |
||
| 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 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 (Fulfillment.location.id) field. |
- fulfillment_location_id:123 |
||
| fulfillment_status | string | Filter by the 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 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 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. |
- metafields.custom.on_sale:true- metafields.product.material:"gid://shopify/Metaobject/43458085" |
||
| name | string | Filter by the order 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 field. |
- po_number:P01001 |
||
| processed_at | time | Filter by the order 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 |
||
| requested_order_edit_status | string | Filter by the order's displayRequestedEditStatus to track which orders have buyer-initiated requested edits pending merchant action. |
- none- requested- resolved- denied |
- requested_order_edit_status:requested |
|
| return_status | string | Filter by the order's 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 field. |
- high- medium- low- none- pending |
- risk_level:high |
|
| sales_channel | string | Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes. | - sales_channel: some_sales_channel |
||
| shipping_address_validation_result_summary | string | Filter by the validation status of the shipping address. Learn more about validating addresses. | - has_issues- no_issues- not_validated |
- shipping_address_validation_result_summary:no_issues |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- 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 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:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
A list of the customer's orders.
OrderConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: OrderSortKeys - 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.
query: 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 |
||
| cart_token | string | Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order. | - cart_token:abc123 |
||
| channel | string | Filter by the order attribution handle (Order.attribution.handle) field. The legacy channel information handle (ChannelInformation.channelDefinition.handle) field is deprecated but remains supported during the deprecation period. |
- channel:web- channel:web,pos |
||
| channel_id | id | Filter by the channel id field. |
- channel_id:123 |
||
| chargeback_status | string | Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution. | - accepted- charge_refunded- lost- needs_response- under_review- won |
- chargeback_status:accepted |
|
| checkout_token | string | Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order. | - checkout_token:abc123 |
||
| confirmation_number | string | Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique. | - confirmation_number:ABC123 |
||
| created_at | time | Filter by the date and time when the order was created in Shopify's system. | - created_at:'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| credit_card_last4 | string | Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security. | - credit_card_last4:1234 |
||
| current_total_price | float | Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges. | - current_total_price:10- current_total_price:>=5.00 current_total_price:<=20.99 |
||
| customer_id | id | Filter orders by the customer id field. |
- customer_id:123 |
||
| delivery_method | string | Filter by the delivery 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 |
||
| 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 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 (Fulfillment.location.id) field. |
- fulfillment_location_id:123 |
||
| fulfillment_status | string | Filter by the 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 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 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. |
- metafields.custom.on_sale:true- metafields.product.material:"gid://shopify/Metaobject/43458085" |
||
| name | string | Filter by the order 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 field. |
- po_number:P01001 |
||
| processed_at | time | Filter by the order 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 |
||
| requested_order_edit_status | string | Filter by the order's displayRequestedEditStatus to track which orders have buyer-initiated requested order edits pending merchant action. |
- none- requested- resolved- declined |
- requested_order_edit_status:requested |
|
| return_status | string | Filter by the order's 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 field. |
- high- medium- low- none- pending |
- risk_level:high |
|
| sales_channel | string | Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes. | - sales_channel: some_sales_channel |
||
| shipping_address_validation_result_summary | string | Filter by the validation status of the shipping address. Learn more about validating addresses. | - has_issues- no_issues- not_validated |
- shipping_address_validation_result_summary:no_issues |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- 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 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:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
includeRestOfWorldincludeRestOfWorld on DiscountCountriesWhether the discount is applicable to countries that haven't been defined in the shop's shipping zones.
Boolean!Whether the discount is applicable to countries that haven't been defined in the shop's shipping zones.
Boolean!displayRequestedEditStatusdisplayRequestedEditStatus on OrderThe order's aggregated requested edit status for display purposes.
Indicates the overall state of buyer-initiated requested edits for the order,
helping merchants track and manage pending requests.
OrderDisplayRequestedEditStatus!The order's aggregated requested order edit status for display purposes.
Indicates the overall state of buyer-initiated requested order edits for the order,
helping merchants track and manage pending requests.
OrderDisplayRequestedEditStatus!requestedOrderEditsrequestedOrderEdits on OrderThe buyer-initiated requested edits on unfulfilled line items for this order.
RequestedOrderEditConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
The buyer-initiated requested order edits on unfulfilled line items for this order.
RequestedOrderEditConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
DENIEDDECLINEDcreatedAtcreatedAt on RequestedOrderEditThe date and time when the requested edit was created.
DateTime!The date and time when the requested order edit was created.
DateTime!lineItemslineItems on RequestedOrderEditThe line item changes included in this requested edit, grouped by the type of change.
RequestedOrderEditLineItems!The line item changes included in this requested order edit, grouped by the type of change.
RequestedOrderEditLineItems!orderorder on RequestedOrderEditThe order associated with this requested edit.
Order!The order associated with this requested order edit.
Order!requestDeclinedAtrequestDeclinedAt on RequestedOrderEditThe date and time when the requested edit was declined.
DateTimeThe date and time when the requested order edit was declined.
DateTimerequestResolvedAtrequestResolvedAt on RequestedOrderEditThe date and time when the requested edit was resolved.
DateTimeThe date and time when the requested order edit was resolved.
DateTimestatusstatus on RequestedOrderEditThe status of this requested edit.
RequestedOrderEditStatus!The status of this requested order edit.
RequestedOrderEditStatus!updatedAtupdatedAt on RequestedOrderEditThe date and time when the requested edit was last updated.
DateTime!The date and time when the requested order edit was last updated.
DateTime!requestedOrderEditrequestedOrderEdit on RequestedOrderEditCreatePayloadThe created requested edit.
RequestedOrderEditThe created requested order edit.
RequestedOrderEditrequestedOrderEditrequestedOrderEdit on RequestedOrderEditDeclinePayloadThe declined requested edit.
RequestedOrderEditThe declined requested order edit.
RequestedOrderEditlineItemlineItem on RequestedOrderEditLineItemThe order line item associated with this requested edit line item.
LineItem!The order line item associated with this requested order edit line item.
LineItem!quantityquantity on RequestedOrderEditLineItemThe quantity requested for this line item in the requested edit.
Int!The quantity requested for this line item in the requested order edit.
Int!requestedOrderEditrequestedOrderEdit on RequestedOrderEditResolvePayloadThe resolved requested edit.
RequestedOrderEditThe resolved requested order edit.
RequestedOrderEditDENIEDDECLINEDbrandThe shop's brand settings.
ordersorders on ShopA list of the shop's orders.
OrderConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: OrderSortKeys - 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.
query: 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 |
||
| cart_token | string | Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order. | - cart_token:abc123 |
||
| channel | string | Filter by the order attribution handle (Order.attribution.handle) field. The legacy channel information handle (ChannelInformation.channelDefinition.handle) field is deprecated but remains supported during the deprecation period. |
- channel:web- channel:web,pos |
||
| channel_id | id | Filter by the channel id field. |
- channel_id:123 |
||
| chargeback_status | string | Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution. | - accepted- charge_refunded- lost- needs_response- under_review- won |
- chargeback_status:accepted |
|
| checkout_token | string | Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order. | - checkout_token:abc123 |
||
| confirmation_number | string | Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique. | - confirmation_number:ABC123 |
||
| created_at | time | Filter by the date and time when the order was created in Shopify's system. | - created_at:'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| credit_card_last4 | string | Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security. | - credit_card_last4:1234 |
||
| current_total_price | float | Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges. | - current_total_price:10- current_total_price:>=5.00 current_total_price:<=20.99 |
||
| customer_id | id | Filter orders by the customer id field. |
- customer_id:123 |
||
| delivery_method | string | Filter by the delivery 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 |
||
| 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 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 (Fulfillment.location.id) field. |
- fulfillment_location_id:123 |
||
| fulfillment_status | string | Filter by the 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 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 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. |
- metafields.custom.on_sale:true- metafields.product.material:"gid://shopify/Metaobject/43458085" |
||
| name | string | Filter by the order 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 field. |
- po_number:P01001 |
||
| processed_at | time | Filter by the order 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 |
||
| requested_order_edit_status | string | Filter by the order's displayRequestedEditStatus to track which orders have buyer-initiated requested edits pending merchant action. |
- none- requested- resolved- denied |
- requested_order_edit_status:requested |
|
| return_status | string | Filter by the order's 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 field. |
- high- medium- low- none- pending |
- risk_level:high |
|
| sales_channel | string | Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes. | - sales_channel: some_sales_channel |
||
| shipping_address_validation_result_summary | string | Filter by the validation status of the shipping address. Learn more about validating addresses. | - has_issues- no_issues- not_validated |
- shipping_address_validation_result_summary:no_issues |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- 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 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:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
A list of the shop's orders.
OrderConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: OrderSortKeys - 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.
query: 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 |
||
| cart_token | string | Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order. | - cart_token:abc123 |
||
| channel | string | Filter by the order attribution handle (Order.attribution.handle) field. The legacy channel information handle (ChannelInformation.channelDefinition.handle) field is deprecated but remains supported during the deprecation period. |
- channel:web- channel:web,pos |
||
| channel_id | id | Filter by the channel id field. |
- channel_id:123 |
||
| chargeback_status | string | Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution. | - accepted- charge_refunded- lost- needs_response- under_review- won |
- chargeback_status:accepted |
|
| checkout_token | string | Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order. | - checkout_token:abc123 |
||
| confirmation_number | string | Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique. | - confirmation_number:ABC123 |
||
| created_at | time | Filter by the date and time when the order was created in Shopify's system. | - created_at:'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| credit_card_last4 | string | Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security. | - credit_card_last4:1234 |
||
| current_total_price | float | Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges. | - current_total_price:10- current_total_price:>=5.00 current_total_price:<=20.99 |
||
| customer_id | id | Filter orders by the customer id field. |
- customer_id:123 |
||
| delivery_method | string | Filter by the delivery 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 |
||
| 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 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 (Fulfillment.location.id) field. |
- fulfillment_location_id:123 |
||
| fulfillment_status | string | Filter by the 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 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 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. |
- metafields.custom.on_sale:true- metafields.product.material:"gid://shopify/Metaobject/43458085" |
||
| name | string | Filter by the order 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 field. |
- po_number:P01001 |
||
| processed_at | time | Filter by the order 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 |
||
| requested_order_edit_status | string | Filter by the order's displayRequestedEditStatus to track which orders have buyer-initiated requested order edits pending merchant action. |
- none- requested- resolved- declined |
- requested_order_edit_status:requested |
|
| return_status | string | Filter by the order's 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 field. |
- high- medium- low- none- pending |
- risk_level:high |
|
| sales_channel | string | Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes. | - sales_channel: some_sales_channel |
||
| shipping_address_validation_result_summary | string | Filter by the validation status of the shipping address. Learn more about validating addresses. | - has_issues- no_issues- not_validated |
- shipping_address_validation_result_summary:no_issues |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- 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 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:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
BRANDINGREQUESTED_ORDER_EDIT_DENIEDBRAND_UPDATEREQUESTED_ORDER_EDIT_DECLINED