Custom scalars
Scalars are primitive values such as `Int` or `String.` GraphQL queries and responses take the form of a hierarchical tree; the leaves on these trees are GraphQL scalars. For more information, see the GraphQL spec.| Scalar | Definition |
|---|---|
| Boolean |
Represents |
| DateTime |
An ISO-8601 encoded UTC date time string. Example value: |
| Decimal |
A signed decimal number, which supports arbitrary precision and is serialized as a string. Example value: |
| Float |
Represents signed double-precision fractional values as specified by IEEE 754. |
| HTML |
A string containing HTML code. Example value: |
| ID |
Represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String, but it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID. Admin API example value: Storefront API example value: |
| Int |
Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. |
| Money |
A monetary value string. Example value: |
| String |
Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. |
| URL |
An RFC 3986 and RFC 3987 compliant URI string. Example value: |
| Scalar | Definition |
|---|---|
| Boolean |
Represents |
| DateTime |
An ISO-8601 encoded UTC date time string. Example value: |
| Decimal |
A signed decimal number, which supports arbitrary precision and is serialized as a string. Example value: |
| Float |
Represents signed double-precision fractional values as specified by IEEE 754. |
| HTML |
A string containing HTML code. Example value: |
| ID |
Represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String, but it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID. Admin API example value: Storefront API example value: |
| Int |
Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. |
| Money |
A monetary value string. Example value: |
| String |
Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. |
| URL |
An RFC 3986 and RFC 3987 compliant URI string. Example value: |
| Scalar | Definition |
|---|---|
| Boolean |
Represents |
| DateTime |
An ISO-8601 encoded UTC date time string. Example value: |
| Decimal |
A signed decimal number, which supports arbitrary precision and is serialized as a string. Example value: |
| Float |
Represents signed double-precision fractional values as specified by IEEE 754. |
| HTML |
A string containing HTML code. Example value: |
| ID |
Represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String, but it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID. Admin API example value: Storefront API example value: |
| Int |
Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. |
| Money |
A monetary value string. Example value: |
| String |
Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. |
| URL |
An RFC 3986 and RFC 3987 compliant URI string. Example value: |
| Scalar | Definition |
|---|---|
| Boolean |
Represents |
| DateTime |
An ISO-8601 encoded UTC date time string. Example value: |
| Decimal |
A signed decimal number, which supports arbitrary precision and is serialized as a string. Example value: |
| Float |
Represents signed double-precision fractional values as specified by IEEE 754. |
| HTML |
A string containing HTML code. Example value: |
| ID |
Represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String, but it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID. Admin API example value: Storefront API example value: |
| Int |
Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. |
| Money |
A monetary value string. Example value: |
| String |
Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. |
| URL |
An RFC 3986 and RFC 3987 compliant URI string. Example value: |
| Scalar | Definition |
|---|---|
| Boolean |
Represents |
| DateTime |
An ISO-8601 encoded UTC date time string. Example value: |
| Decimal |
A signed decimal number, which supports arbitrary precision and is serialized as a string. Example value: |
| Float |
Represents signed double-precision fractional values as specified by IEEE 754. |
| HTML |
A string containing HTML code. Example value: |
| ID |
Represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String, but it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID. Admin API example value: Storefront API example value: |
| Int |
Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. |
| Money |
A monetary value string. Example value: |
| String |
Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. |
| URL |
An RFC 3986 and RFC 3987 compliant URI string. Example value: |