SCALAR
String
Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.
link GraphQL Schema definition
- scalar String
link Require by
- AppliedGiftCardDetails about the gift card used on the checkout.
- AttributeRepresents a generic custom attribute.
- AttributeInputSpecifies the input fields required for an attribute.
- CheckoutA container for all the information required to checkout items and pay.
- CheckoutAttributesUpdateInputSpecifies the fields required to update a checkout's attributes.
- CheckoutCreateInputSpecifies the fields required to create a checkout.
- CheckoutLineItemA single line item in the checkout, grouped by variant and attributes.
- CheckoutLineItemEdgenull
- CollectionA collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse.
- CollectionEdgenull
- CreditCardCredit card information used for a payment.
- CreditCardPaymentInputSpecifies the fields required to complete a checkout with a Shopify vaulted credit card payment.
- CustomerA customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout.
- CustomerAccessTokenA CustomerAccessToken represents the unique token required to make modifications to the customer object.
- CustomerAccessTokenCreateInputSpecifies the input fields required to create a customer access token.
- CustomerAccessTokenDeletePayloadnull
- CustomerActivateInputSpecifies the input fields required to activate a customer.
- CustomerAddressDeletePayloadnull
- CustomerCreateInputSpecifies the fields required to create a new Customer.
- CustomerResetInputSpecifies the fields required to reset a Customer’s password.
- CustomerUpdateInputSpecifies the fields required to update the Customer information.
- DomainRepresents a web address.
- ImageRepresents an image resource.
- ImageEdgenull
- MailingAddressRepresents a mailing address for customers and shipping.
- MailingAddressEdgenull
- MailingAddressInputSpecifies the fields accepted to create or update a mailing address.
- MutationThe schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start.
- OrderAn order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.
- OrderEdgenull
- OrderLineItemRepresents a single line in an order. There is one line item for each distinct product variant.
- OrderLineItemEdgenull
- PaymentA payment applied to a checkout.
- ProductA product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty).
- ProductEdgenull
- ProductOptionCustom product property names like "Size", "Color", and "Material". Products are based on permutations of these options. A product may have a maximum of 3 options. 255 characters limit each.
- ProductVariantA product variant represents a different version of a product, such as differing sizes or differing colors.
- ProductVariantEdgenull
- QueryRootThe schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start.
- SelectedOptionCustom properties that a shop owner can use to define product variants. Multiple options can exist. Options are represented as: option1, option2, option3, etc.
- SelectedOptionInputSpecifies the input fields required for a selected option.
- ShippingRateA shipping rate to be applied to a checkout.
- ShopShop represents a collection of the general settings and information about the shop.
- ShopPolicyPolicy that a merchant has configured for their store, such as their refund or privacy policy.
- TokenizedPaymentInputSpecifies the fields required to complete a checkout with a tokenized payment.
- UserErrorRepresents an error in the input of a mutation.
- __DirectiveA Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.
- __EnumValueOne possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.
- __FieldObject and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.
- __InputValueArguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.
- __TypeThe fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.