Skip to main content
enum

The set of valid sort keys for the Order query.

Sorts by the date and time the order was created.

Sorts by the current total price of an order in the shop currency, including any returns/refunds/removals.

Sorts by the customer's name.

Sort by shipping address to analyze regional sales patterns or plan logistics.

Sorts by the financial status of the order.

Sorts by the order's fulfillment status.

Sort by the id value.

Sorts by the order number.

Sort by the purchase order number to match external procurement systems or track recent orders.

Sorts by the date and time the order was processed.

Sort by relevance to the search terms when the query parameter is specified on the connection. Don't use this sort key when no search query is specified.

Anchor to TOTAL_ITEMS_QUANTITYTOTAL_ITEMS_QUANTITY

Sort by the total quantity of all line items to identify large purchases or analyze inventory demand patterns.

Sorts by the total sold price of an order in the shop currency, excluding any returns/refunds/removals.

Sorts by the date and time the order was last updated.


Was this section helpful?

•ARGUMENT

A business entity that purchases from the shop as part of B2B commerce. Companies organize multiple locations and contacts who can place orders on behalf of the organization. CompanyLocation objects can have custom pricing through Catalog and PriceList configurations.

•ARGUMENT

A person who acts on behalf of a Company to make B2B purchases. Company contacts are associated with Customer accounts and can place orders on behalf of their company.

Each contact can be assigned to one or more CompanyLocation objects with specific roles that determine their permissions and access to catalogs, pricing, and payment terms configured for those locations.

•ARGUMENT

A location or branch of a Company that's a customer of the shop. Company locations enable B2B customers to manage multiple branches with distinct billing and shipping addresses, tax settings, and checkout configurations.

Each location can have its own Catalog objects that determine which products are published and their pricing. The BuyerExperienceConfiguration determines checkout behavior including PaymentTerms, and whether orders require merchant review. B2B customers select which location they're purchasing for, which determines the applicable catalogs, pricing, TaxExemption values, and checkout settings for their Order objects.

•ARGUMENT

Information about a customer of the shop, such as the customer's contact details, purchase history, and marketing preferences.

Tracks the customer's total spending through the amountSpent field and provides access to associated data such as payment methods and subscription contracts.


Caution

Only use this 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.


•ARGUMENT

The fields that will be kept as part of a customer merge preview.

•ARGUMENT

The central configuration and settings hub for a Shopify store. Access business information, operational preferences, feature availability, and store-wide settings that control how the shop operates.

Includes core business details like the shop name, contact emails, billing address, and currency settings. The shop configuration determines customer account requirements, available sales channels, enabled features, payment settings, and policy documents. Also provides access to shop-level resources such as staff members, fulfillment services, navigation settings, and storefront access tokens.

•ARGUMENT

The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start.


Was this section helpful?