Has Metafields

A metafield found by namespace and key.

Anchor to keykey •String! required: The identifier for the metafield.
Anchor to namespacenamespace •String! required: A container for a set of metafields.

Anchor to metafieldsmetafields

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

Anchor to Company Company

required

The list of metafields to retrieve by namespace and key.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

•OBJECT

Represents a company's information.

Anchor to draftOrdersdraftOrders

•DraftOrderConnection!

non-null

The list of company draft orders.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•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.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to company_contact_id •id
Anchor to created_at •time
Anchor to customer_id •id
Anchor to id •id: Filter by id range.
Anchor to name •string
Anchor to purchasing_entity •string
Anchor to source •string
Anchor to status •string
Anchor to tag •string
Anchor to updated_at •time

Default:false

Reverse the order of the underlying list.

•DraftOrderByCompanySortKeys

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.

Anchor to externalIdexternalId

•String

A unique externally-supplied ID for the company.

•ID!

non-null

A globally-unique ID.

Anchor to locationslocations

•CompanyLocationConnection!

non-null

The list of locations that the business of the business contact belongs to.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•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.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to company_contact_id •id
Anchor to company_id •id
Anchor to created_at •time
Anchor to external_id •string
Anchor to id •id: Filter by id range.
Anchor to ids •string
Anchor to metafields.{namespace}.{key} •mixed: Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.
Anchor to •: metafields.custom.on_sale:true
- metafields.product.material:"gid://shopify/Metaobject/43458085"
Anchor to name •string
Anchor to updated_at •time

Default:false

Reverse the order of the underlying list.

•CompanyLocationSortKeys

Default:ID

Sort the underlying list by the given key.

Anchor to metafieldmetafield

A metafield found by namespace and key.

Anchor to keykey •String! required: The identifier for the metafield.
Anchor to namespacenamespace •String! required: A container for a set of metafields.

Anchor to metafieldsmetafields

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

required

The list of metafields to retrieve by namespace and key.

non-null

The name of the company.

Anchor to ordersorders

•OrderConnection!

non-null

The list of customer orders under the company.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•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.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to confirmation_number •string
Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to name •string
Anchor to order_number •string
Anchor to processed_at •time
Anchor to purchasing_company_contact_id •id
Anchor to purchasing_company_id •id
Anchor to purchasing_company_location_id •id
Anchor to purchasing_entity •string
Anchor to shipment_status •string
Anchor to updated_at •time

Default:false

Reverse the order of the underlying list.

Anchor to CompanyLocation CompanyLocation

•OrderByCompanySortKeys

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.

•OBJECT

Represents a company's business location.

Anchor to billingAddressbillingAddress

•CompanyAddress

The billing address of the company location.

Anchor to buyerExperienceConfigurationbuyerExperienceConfiguration

•BuyerExperienceConfiguration

The configuration of the buyer's B2B checkout.

Anchor to contactscontacts

•CompanyContactConnection!

non-null

The list of contacts under a particular business location.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•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.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to company_id •id
Anchor to company_location_id •id
Anchor to created_at •time
Anchor to email •string
Anchor to id •id: Filter by id range.
Anchor to location_name •string
Anchor to name •string
Anchor to role_name •string
Anchor to status •string
Anchor to updated_at •time

Default:false

Reverse the order of the underlying list.

•CompanyContactSortKeys

Default:ID

Sort the underlying list by the given key.

Anchor to draftOrdersdraftOrders

•DraftOrderConnection!

non-null

The list of company draft orders.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•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.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to company_contact_id •id
Anchor to created_at •time
Anchor to customer_id •id
Anchor to id •id: Filter by id range.
Anchor to name •string
Anchor to purchasing_entity •string
Anchor to source •string
Anchor to status •string
Anchor to tag •string
Anchor to updated_at •time

Default:false

Reverse the order of the underlying list.

•DraftOrderByLocationSortKeys

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.

Anchor to externalIdexternalId

•String

A unique externally-supplied ID for the location.

•ID!

non-null

A globally-unique ID.

Anchor to metafieldmetafield

A metafield found by namespace and key.

Anchor to keykey •String! required: The identifier for the metafield.
Anchor to namespacenamespace •String! required: A container for a set of metafields.

Anchor to metafieldsmetafields

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

required

The list of metafields to retrieve by namespace and key.

non-null

The name of the company location.

Anchor to ordersorders

•OrderConnection!

non-null

The list of customer orders under the company.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•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.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to confirmation_number •string
Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to name •string
Anchor to order_number •string
Anchor to processed_at •time
Anchor to purchasing_company_contact_id •id
Anchor to purchasing_company_id •id
Anchor to purchasing_company_location_id •id
Anchor to purchasing_entity •string
Anchor to shipment_status •string
Anchor to updated_at •time

Default:false

Reverse the order of the underlying list.

•CompanyContactRoleAssignmentConnection!

•OrderByLocationSortKeys

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.

Anchor to roleAssignmentsroleAssignments

non-null

The list of roles assigned to this location.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•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.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to company_contact_id •id
Anchor to company_contact_role_id •id
Anchor to company_id •id
Anchor to company_location_id •id
Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to location_name •string
Anchor to role_name •string
Anchor to updated_at •time

Default:false

Reverse the order of the underlying list.

•CompanyContactRoleAssignmentSortKeys

Default:ID

Sort the underlying list by the given key.

Anchor to shippingAddressshippingAddress

•CompanyAddress

The shipping address of the company location.

Anchor to storeCreditAccountsstoreCreditAccounts

•StoreCreditAccountConnection!

non-null

A list of the owner resource's store credit accounts. Store credit accounts are not shown for shops with store credit disabled at checkout.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Anchor to Customer Customer

•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.

Anchor to currency_code •string
Anchor to id •id: Filter by id range.

Anchor to taxIdentifiertaxIdentifier

•String

The tax id of the company location.

Anchor to marketmarket

•Market!

non-nullDeprecated

•OBJECT

Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data requirements.

Anchor to addressesaddresses

•CustomerAddressConnection!

non-null

The addresses associated with the customer.

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.
Anchor to skipDefaultskipDefault •Boolean Default:false: A flag indicating whether the default address should be included.

Anchor to companyContactscompanyContacts

•CompanyContactConnection!

non-null

The list of contacts the customer is associated with.

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to creationDatecreationDate

non-null

The date and time when the customer was created.

Anchor to defaultAddressdefaultAddress

•CustomerAddress

The default address of the customer.

Anchor to displayNamedisplayName

non-null

The full name of the customer, based on the first_name and last_name values. If these aren't available, it falls back to the customer's email address, and if that isn't available, the customer's phone number.

Anchor to draftOrdersdraftOrders

•DraftOrderConnection!

non-null

The Draft Orders associated with the customer.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•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.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to company_contact_id •id
Anchor to created_at •time
Anchor to customer_id •id
Anchor to id •id: Filter by id range.
Anchor to name •string
Anchor to purchasing_entity •string
Anchor to source •string
Anchor to status •string
Anchor to tag •string
Anchor to updated_at •time

Default:false

Reverse the order of the underlying list.

•DraftOrderSortKeys

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.

Anchor to emailAddressemailAddress

•CustomerEmailAddress

The email address of the customer.

Anchor to firstNamefirstName

•String

The first name of the customer.

•ID!

non-null

A globally-unique ID.

Anchor to imageUrlimageUrl

•URL!

non-null

The URL to the avatar image of the customer.

Anchor to lastNamelastName

•String

The last name of the customer.

Anchor to metafieldmetafield

A metafield found by namespace and key.

Anchor to keykey •String! required: The identifier for the metafield.
Anchor to namespacenamespace •String! required: A container for a set of metafields.

Anchor to metafieldsmetafields

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

required

The list of metafields to retrieve by namespace and key.

Anchor to ordersorders

•OrderConnection!

non-null

The orders associated with the customer.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•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.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to confirmation_number •string
Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to name •string
Anchor to order_number •string
Anchor to processed_at •time
Anchor to purchasing_company_contact_id •id
Anchor to purchasing_company_id •id
Anchor to purchasing_company_location_id •id
Anchor to purchasing_entity •string
Anchor to shipment_status •string
Anchor to updated_at •time

Default:false

Reverse the order of the underlying list.

•StoreCreditAccountConnection!

•OrderSortKeys

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.

Anchor to phoneNumberphoneNumber

•CustomerPhoneNumber

The phone number of the customer.

Anchor to storeCreditAccountsstoreCreditAccounts

non-null

A list of the owner resource's store credit accounts. Store credit accounts are not shown for shops with store credit disabled at checkout.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•SubscriptionContractConnection!

•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.

Anchor to currency_code •string
Anchor to id •id: Filter by id range.

Anchor to subscriptionContractsubscriptionContract

•SubscriptionContract

Returns a SubscriptionContract resource by ID.

Anchor to idid •ID! required: The ID of the SubscriptionContract to return.

Anchor to subscriptionContractssubscriptionContracts

non-null

The Subscription Contracts associated with the customer.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•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.

Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to last_billing_attempt_error_type •string
Anchor to status •string
Anchor to updated_at •time

Default:false

Reverse the order of the underlying list.

•SubscriptionContractsSortKeys

Default:CREATED_AT

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.

Anchor to tagstags

•[String!]!

non-null

A comma-separated list of tags that have been added to the customer.

Anchor to lastIncompleteCheckoutlastIncompleteCheckout

•Checkout

Deprecated

Anchor to Order Order

•OBJECT

A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data requirements.

Anchor to agreementsagreements

•SalesAgreementConnection!

non-null

A list of sales agreements associated with the order.

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to billingAddressbillingAddress

•CustomerAddress

The mailing address provided by the customer. Not all orders have a mailing address.

Anchor to cancelledAtcancelledAt

•DateTime

The date and time when the order was canceled. Returns null if the order wasn't canceled.

Anchor to cancelReasoncancelReason

•OrderCancelReason

The reason for the cancellation of the order. Returns null if the order wasn't canceled.

Anchor to confirmationNumberconfirmationNumber

•String

A randomly generated alpha-numeric identifier for the order that may be shown to the customer instead of the sequential order name. For example, "XPAV284CT", "R50KELTJP" or "35PKUN0UJ". This value isn't guaranteed to be unique.

Anchor to createdAtcreatedAt

•DiscountApplicationConnection!

non-null

The date and time when the order was created.

Anchor to currencyCodecurrencyCode

•CurrencyCode!

non-null

The shop currency when the order was placed.

Anchor to customercustomer

•Customer

The customer who placed the order.

Anchor to customerLocalecustomerLocale

•String

The locale code representing the region where this specific order was placed.

Anchor to discountApplicationsdiscountApplications

non-null

The discounts that have been applied to the order.

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to draftOrderdraftOrder

•DraftOrder

The draft order associated with the order.

Anchor to editededited

•Boolean!

non-null

Whether the order has been edited or not.

Anchor to emailemail

•String

The email address of the customer.

Anchor to financialStatusfinancialStatus

•OrderFinancialStatus

The financial status of the order.

Anchor to fulfillmentsfulfillments

•FulfillmentConnection!

non-null

The fulfillments associated with the order.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•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.

Anchor to id •id: Filter by id range.
Anchor to order_id •id
Anchor to shipment_status •string
Anchor to status •string

Default:false

Reverse the order of the underlying list.

•FulfillmentSortKeys

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.

Anchor to fulfillmentStatusfulfillmentStatus

•OrderFulfillmentStatus!

non-null

The fulfillment status of the order.

•ID!

non-null

A globally-unique ID.

Anchor to lineItemslineItems

•LineItemConnection!

non-null

The list of line items of the order.

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to locationNamelocationName

•String

The name of the fulfillment location assigned at the time of order creation.

Anchor to metafieldmetafield

A metafield found by namespace and key.

Anchor to keykey •String! required: The identifier for the metafield.
Anchor to namespacenamespace •String! required: A container for a set of metafields.

Anchor to metafieldsmetafields

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

required

The list of metafields to retrieve by namespace and key.

non-null

The identifier for the order that appears on the order. For example, #1000 or _Store1001.

Anchor to notenote

•String

The order's notes.

Anchor to numbernumber

•Int!

non-null

A unique numeric identifier for the order, used by both the shop owner and customer.

Anchor to paymentInformationpaymentInformation

•OrderPaymentInformation

The payment information for the order.

Anchor to phonephone

•String

The phone number of the customer for SMS notifications.

Anchor to poNumberpoNumber

•String

The purchase order number of the order.

Anchor to processedAtprocessedAt

non-null

The date and time when the order was processed. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated based on current date and time.

Anchor to purchasingEntitypurchasingEntity

•PurchasingEntity

The purchasing entity for the order.

Anchor to refundsrefunds

•[Refund!]!

non-null

A list of refunds associated with the order.

Anchor to requiresShippingrequiresShipping

•Boolean!

non-null

Whether the order requires shipping.

Anchor to returnInformationreturnInformation

•OrderReturnInformation!

non-null

The return information for the order.

Anchor to returnsreturns

•ReturnConnection!

non-null

The list of returns for the order with pagination.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Default:false

Reverse the order of the underlying list.

•SubscriptionContractConnection

•ReturnSortKeys

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.

Anchor to shippingAddressshippingAddress

•CustomerAddress

The mailing address to which the order items are shipped.

Anchor to shippingDiscountAllocationsshippingDiscountAllocations

•[DiscountAllocation!]!

non-null

The discounts that have been allocated onto the shipping line by discount applications.

Anchor to shippingLineshippingLine

•ShippingLine

A summary of all shipping costs on the order.

Anchor to statusPageUrlstatusPageUrl

•URL!

non-null

The unique URL for the status page of the order.

Anchor to subscriptionContractssubscriptionContracts

The customer Subscription Contracts associated with the order.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•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.

Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to last_billing_attempt_error_type •string
Anchor to status •string
Anchor to updated_at •time

Default:false

Reverse the order of the underlying list.

•SubscriptionContractsSortKeys

Default:CREATED_AT

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.

Anchor to subtotalsubtotal

The price of the order before duties, shipping, and taxes.

Anchor to totalDutiestotalDuties

The total amount of duties after returns.

Anchor to totalPricetotalPrice

•MoneyV2!

non-null

The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned.

Anchor to totalRefundedtotalRefunded

•MoneyV2!

non-null

The total amount refunded.

Anchor to totalShippingtotalShipping

•MoneyV2!

non-null

The total cost of shipping.

Anchor to totalTaxtotalTax

The total cost of taxes.

Anchor to totalTiptotalTip

The total value of tips.

Anchor to transactionstransactions

•[OrderTransaction!]!

non-null

A list of transactions associated with the order.

Anchor to updatedAtupdatedAt

non-null

The date and time when the order was last updated.

Anchor to Shop Shop

•OBJECT

A collection of the general information about the shop.

Anchor to emailemail

non-null

The email of the shop.

•ID!

non-null

A globally-unique ID.

Anchor to metafieldmetafield

A metafield found by namespace and key.

Anchor to keykey •String! required: The identifier for the metafield.
Anchor to namespacenamespace •String! required: A container for a set of metafields.

Anchor to metafieldsmetafields

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

required

The list of metafields to retrieve by namespace and key.

Anchor to myshopifyDomainmyshopifyDomain

non-null

The shop's .myshopify.com domain name.