Choose a version:

HasMetafields

interface

The information about the metafields associated with the specified resource.

Anchor to FieldsFields

Anchor to metafieldmetafield •Metafield Pre-auth accessible: A metafield found by namespace and key.
Anchor to metafieldsmetafields •[Metafield]! non-nullPre-auth accessible: The metafields associated with the resource matching the supplied list of namespaces and keys.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Company

•OBJECT

Represents a company's information.

Anchor to draftOrdersdraftOrders •DraftOrderConnection! non-null: The list of company draft orders.
Anchor to externalIdexternalId •String Pre-auth accessible: A unique externally-supplied ID for the company.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to locationslocations •CompanyLocationConnection! non-null: The list of locations that the business of the business contact belongs to.
Anchor to metafieldmetafield •Metafield Pre-auth accessible: A metafield found by namespace and key.
Anchor to metafieldsmetafields •[Metafield]! non-nullPre-auth accessible: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to namename •String! non-nullPre-auth accessible: The name of the company.
Anchor to ordersorders •OrderConnection! non-null: The list of customer orders under the company.

CompanyLocation

•OBJECT

Represents a company's business location.

Anchor to billingAddressbillingAddress •CompanyAddress Pre-auth accessible: The billing address of the company location.
Anchor to buyerExperienceConfigurationbuyerExperienceConfiguration •BuyerExperienceConfiguration Pre-auth accessible: The configuration of the buyer's B2B checkout.
Anchor to contactscontacts •CompanyContactConnection! non-null: The list of contacts under a particular business location.
Anchor to draftOrdersdraftOrders •DraftOrderConnection! non-null: The list of company draft orders.
Anchor to externalIdexternalId •String Pre-auth accessible: A unique externally-supplied ID for the location.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to metafieldmetafield •Metafield Pre-auth accessible: A metafield found by namespace and key.
Anchor to metafieldsmetafields •[Metafield]! non-nullPre-auth accessible: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to namename •String! non-nullPre-auth accessible: The name of the company location.
Anchor to ordersorders •OrderConnection! non-null: The list of customer orders under the company.
Anchor to roleAssignmentsroleAssignments •CompanyContactRoleAssignmentConnection! non-null: The list of roles assigned to this location.
Anchor to shippingAddressshippingAddress •CompanyAddress Pre-auth accessible: The shipping address of the company location.
Anchor to taxIdentifiertaxIdentifier •String: The tax id of the company location.
Anchor to marketmarket •Market! non-nullDeprecatedPre-auth accessible

Customer

•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 companyContactscompanyContacts •CompanyContactConnection! non-null: The list of contacts the customer is associated with.
Anchor to creationDatecreationDate •DateTime! non-null: The date and time when the customer was created.
Anchor to defaultAddressdefaultAddress •CustomerAddress: The default address of the customer.
Anchor to displayNamedisplayName •String! 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.
Anchor to emailAddressemailAddress •CustomerEmailAddress Pre-auth accessible: The email address of the customer.
Anchor to firstNamefirstName •String: The first name of the customer.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to imageUrlimageUrl •URL! non-null: The URL to the avatar image of the customer.
Anchor to lastIncompleteCheckoutlastIncompleteCheckout •Checkout: The customer's most recently updated, incomplete checkout.
Anchor to lastNamelastName •String: The last name of the customer.
Anchor to metafieldmetafield •Metafield Pre-auth accessible: A metafield found by namespace and key.
Anchor to metafieldsmetafields •[Metafield]! non-nullPre-auth accessible: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to ordersorders •OrderConnection! non-null: The orders associated with the customer.
Anchor to phoneNumberphoneNumber •CustomerPhoneNumber Pre-auth accessible: The phone number of the customer.
Anchor to storeCreditAccountsstoreCreditAccounts •StoreCreditAccountConnection! non-nullPre-auth accessible: A list of the owner resource's store credit accounts. Store credit accounts are not shown for shops with store credit disabled at checkout.
Anchor to subscriptionContractsubscriptionContract •SubscriptionContract: A Subscription Contract resource identified by ID.
Anchor to subscriptionContractssubscriptionContracts •SubscriptionContractConnection! non-null: The Subscription Contracts associated with the customer.
Anchor to tagstags •[String!]! non-null: A comma-separated list of tags that have been added to the customer.

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-nullPre-auth accessible: A list of sales agreements associated with the order.
Anchor to billingAddressbillingAddress •CustomerAddress Pre-auth accessible: The mailing address provided by the customer. Not all orders have a mailing address.
Anchor to cancelledAtcancelledAt •DateTime Pre-auth accessible: The date and time when the order was canceled. Returns null if the order wasn't canceled.
Anchor to cancelReasoncancelReason •OrderCancelReason Pre-auth accessible: The reason for the cancellation of the order. Returns null if the order wasn't canceled.
Anchor to confirmationNumberconfirmationNumber •String Pre-auth accessible: 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 •DateTime! non-nullPre-auth accessible: The date and time when the order was created.
Anchor to currencyCodecurrencyCode •CurrencyCode! non-nullPre-auth accessible: The shop currency when the order was placed.
Anchor to customercustomer •Customer Pre-auth accessible: The customer who placed the order.
Anchor to customerLocalecustomerLocale •String Pre-auth accessible: The locale code representing the region where this specific order was placed.
Anchor to discountApplicationsdiscountApplications •DiscountApplicationConnection! non-nullPre-auth accessible: The discounts that have been applied to the order.
Anchor to draftOrderdraftOrder •DraftOrder Pre-auth accessible: The draft order associated with the order.
Anchor to editededited •Boolean! non-nullPre-auth accessible: Whether the order has been edited or not.
Anchor to emailemail •String Pre-auth accessible: The email address of the customer.
Anchor to financialStatusfinancialStatus •OrderFinancialStatus Pre-auth accessible: The financial status of the order.
Anchor to fulfillmentsfulfillments •FulfillmentConnection! non-nullPre-auth accessible: The fulfillments associated with the order.
Anchor to fulfillmentStatusfulfillmentStatus •OrderFulfillmentStatus! non-nullPre-auth accessible: The fulfillment status of the order.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to lineItemslineItems •LineItemConnection! non-nullPre-auth accessible: The list of line items of the order.
Anchor to locationNamelocationName •String Pre-auth accessible: The name of the fulfillment location assigned at the time of order creation.
Anchor to metafieldmetafield •Metafield Pre-auth accessible: A metafield found by namespace and key.
Anchor to metafieldsmetafields •[Metafield]! non-nullPre-auth accessible: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to namename •String! non-nullPre-auth accessible: The identifier for the order that appears on the order. For example, #1000 or _Store1001.
Anchor to notenote •String Pre-auth accessible: The order's notes.
Anchor to numbernumber •Int! non-nullPre-auth accessible: A unique numeric identifier for the order, used by both the shop owner and customer.
Anchor to paymentInformationpaymentInformation •OrderPaymentInformation Pre-auth accessible: The payment information for the order.
Anchor to phonephone •String: The phone number of the customer for SMS notifications.
Anchor to poNumberpoNumber •String Pre-auth accessible: The purchase order number of the order.
Anchor to processedAtprocessedAt •DateTime! non-nullPre-auth accessible: 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 Pre-auth accessible: The purchasing entity for the order.
Anchor to refundsrefunds •[Refund!]! non-nullPre-auth accessible: A list of refunds associated with the order.
Anchor to requiresShippingrequiresShipping •Boolean! non-nullPre-auth accessible: Whether the order requires shipping.
Anchor to returnInformationreturnInformation •OrderReturnInformation! non-nullPre-auth accessible: The return information for the order.
Anchor to returnsreturns •ReturnConnection! non-nullPre-auth accessible: The list of returns for the order with pagination.
Anchor to shippingAddressshippingAddress •CustomerAddress Pre-auth accessible: The mailing address to which the order items are shipped.
Anchor to shippingDiscountAllocationsshippingDiscountAllocations •[DiscountAllocation!]! non-nullPre-auth accessible: The discounts that have been allocated onto the shipping line by discount applications.
Anchor to shippingLineshippingLine •ShippingLine Pre-auth accessible: A summary of all shipping costs on the order.
Anchor to statusPageUrlstatusPageUrl •URL! non-nullPre-auth accessible: The unique URL for the status page of the order.
Anchor to subscriptionContractssubscriptionContracts •SubscriptionContractConnection: The customer Subscription Contracts associated with the order.
Anchor to subtotalsubtotal •MoneyV2 Pre-auth accessible: The price of the order before duties, shipping, and taxes.
Anchor to totalDutiestotalDuties •MoneyV2 Pre-auth accessible: The total amount of duties after returns.
Anchor to totalPricetotalPrice •MoneyV2! non-nullPre-auth accessible: 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-nullPre-auth accessible: The total amount refunded.
Anchor to totalShippingtotalShipping •MoneyV2! non-nullPre-auth accessible: The total cost of shipping.
Anchor to totalTaxtotalTax •MoneyV2 Pre-auth accessible: The total cost of taxes.
Anchor to totalTiptotalTip •MoneyV2 Pre-auth accessible: The total value of tips.
Anchor to transactionstransactions •[OrderTransaction!]! non-nullPre-auth accessible: A list of transactions associated with the order.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the order was last updated.

Shop

•OBJECT

A collection of the general information about the shop.

Anchor to emailemail •String! non-null: The email of the shop.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to metafieldmetafield •Metafield Pre-auth accessible: A metafield found by namespace and key.
Anchor to metafieldsmetafields •[Metafield]! non-nullPre-auth accessible: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to myshopifyDomainmyshopifyDomain •String! non-null: The shop's .myshopify.com domain name.
Anchor to namename •String! non-null: The name of the shop.
Anchor to shopPoliciesshopPolicies •[ShopPolicy!]! non-null: The list of all legal policies associated with the shop.
Anchor to urlurl •URL! non-null: The URL of the shop's online store.

Was this section helpful?