shop/graphql/schema.graphql

directive @goTag(
    key: String!
    value: String
) on INPUT_FIELD_DEFINITION | FIELD_DEFINITION

directive @goField(
    forceResolver: Boolean,
    name: String
) on INPUT_FIELD_DEFINITION | FIELD_DEFINITION

type Query {
    locations(
        after: String
        before: String
        first: Int
        last: Int
        near: GeoCoordinateInput
        reverse: Boolean = false
        sortKey: LocationSortKeys = ID
    ): LocationConnection!
}

type LocationConnection {
    # A list of edges.
    edges: [LocationEdge!]!

    # A list of the nodes contained in LocationEdge.
    nodes: [Location!]!

    # Information to aid in pagination.
    pageInfo: PageInfo!
}

type LocationEdge {
    # A cursor for use in pagination.
    cursor: String!

    #  The item at the end of LocationEdge.
    node: Location!
}

input GeoCoordinateInput {
    # The coordinate's latitude value.
    latitude: Float!

    # The coordinate's longitude value.
    longitude: Float!
}

enum LocationSortKeys {
    # Sort by the `id` value.
    ID

    # Sort by the `name` value.
    NAME

    # Sort by the `city` value.
    CITY

    # Sort by the `distance` value.
    DISTANCE
}

# An object with an ID field to support global identification, in accordance with the
# Relay specification.
# This interface is used by the node
# and nodes queries.
interface Node {
    # A globally-unique identifier.
    id: ID!


}

# Returns information about pagination in a connection, in accordance with the Relay specification.
type PageInfo {
    # The cursor corresponding to the last node in edges.
    endCursor: String

    # Whether there are more pages to fetch following the current page.
    hasNextPage: Boolean!

    # Whether there are any pages prior to the current page.
    hasPreviousPage: Boolean!

    # The cursor corresponding to the first node in edges.
    startCursor: String
}

# Represents a location where product inventory is held.
type Location implements Node @key(fields: "id") {
    # The address of the location.
    address: LocationAddress!

    # A globally-unique identifier.
    id: ID!

    # The name of the location.
    name: String!
}

# Represents the address of a location.
type LocationAddress {
    # The first line of the address for the location.
    address1: String

    # The second line of the address for the location.
    address2: String

    # The city of the location.
    city: String

    # The country of the location.
    country: String

    # The country code of the location.
    countryCode: String

    # A formatted version of the address for the location.
    formatted: [String!]!

    # The latitude coordinates of the location.
    latitude: Float

    # The longitude coordinates of the location.
    longitude: Float

    # The phone number of the location.
    phone: String

    # The province of the location.
    province: String

    # The code for the province, state, or district of the address of the location.
    provinceCode: String

    # The ZIP code of the location.
    zip: String
}

# ISO 639-1 language codes supported by Shopify.
enum LanguageCode {
    # Afrikaans
    AF

    # Akan
    AK

    # Amharic
    AM

    # Arabic
    AR

    # Assamese
    AS

    # Azerbaijani
    AZ

    # Belarusian
    BE

    # Bulgarian
    BG

    # Bambara
    BM

    # Bangla
    BN

    # Tibetan
    BO

    # Breton
    BR

    # Bosnian
    BS

    # Catalan
    CA

    # Chechen
    CE

    # Czech
    CS

    # Church Slavic
    CU

    # Welsh
    CY

    # Danish
    DA

    # German
    DE

    # Dzongkha
    DZ

    # Ewe
    EE

    # Greek
    EL

    # English
    EN

    # Esperanto
    EO

    # Spanish
    ES

    # Estonian
    ET

    # Basque
    EU

    # Persian
    FA

    # Fulah
    FF

    # Finnish
    FI

    # Faroese
    FO

    # French
    FR

    # Western Frisian
    FY

    # Irish
    GA

    # Scottish Gaelic
    GD

    # Galician
    GL

    # Gujarati
    GU

    # Manx
    GV

    # Hausa
    HA

    # Hebrew
    HE

    # Hindi
    HI

    # Croatian
    HR

    # Hungarian
    HU

    # Armenian
    HY

    # Interlingua
    IA

    # Indonesian
    ID

    # Igbo
    IG

    # Sichuan Yi
    II

    # Icelandic
    IS

    # Italian
    IT

    # Japanese
    JA

    # Javanese
    JV

    # Georgian.
    KA

    # Kikuyu.
    KI

    # Kazakh.
    KK

    # Kalaallisut.
    KL

    # Khmer.
    KM

    # Kannada.
    KN

    # Korean.
    KO

    # Kashmiri.
    KS

    # Kurdish.
    KU

    # Cornish.
    KW

    # Kyrgyz.
    KY

    # Luxembourgish.
    LB

    # Ganda.
    LG

    # Lingala.
    LN

    # Lao.
    LO

    # Lithuanian.
    LT

    # Luba-Katanga.
    LU

    # Latvian.
    LV

    # Malagasy.
    MG

    # Māori.
    MI

    # Macedonian.
    MK

    # Malayalam.
    ML

    # Mongolian.
    MN

    # Marathi.
    MR

    # Malay.
    MS

    # Maltese.
    MT

    # Burmese.
    MY

    # Norwegian (Bokmål).
    NB

    # North Ndebele.
    ND

    # Nepali.
    NE

    # Dutch.
    NL

    # Norwegian Nynorsk.
    NN

    # Norwegian.
    NO

    # Oromo.
    OM

    # Odia.
    OR

    # Ossetic.
    OS

    # Punjabi.
    PA

    # Polish.
    PL

    # Pashto.
    PS

    # Portuguese (Brazil).
    PT_BR

    # Portuguese (Portugal).
    PT_PT

    QU
    # Quechua.

    # Romansh.
    RM

    # Rundi.
    RN

    # Romanian.
    RO

    # Russian.
    RU

    # Kinyarwanda.
    RW

    # Sindhi.
    SD

    # Northern Sami.
    SE

    # Sango.
    SG

    # Sinhala.
    SI

    # Slovak.
    SK

    # Slovenian.
    SL

    # Shona.
    SN

    # Somali.
    SO

    # Albanian.
    SQ

    # Serbian.
    SR

    # Sundanese.
    SU

    # Swedish.
    SV

    # Swahili.
    SW

    # Tamil.
    TA

    # Telugu.
    TE

    # Tajik.
    TG

    # Thai.
    TH

    # Tigrinya.
    TI

    # Turkmen.
    TK

    # Tongan.
    TO

    # Turkish.
    TR

    # Tatar.
    TT

    # Uyghur.
    UG

    # Ukrainian.
    UK

    # Urdu.
    UR

    # Uzbek.
    UZ

    # Vietnamese.
    VI

    # Wolof.
    WO

    # Xhosa.
    XH

    # Yiddish.
    YI

    # Yoruba.
    YO

    # Chinese (Simplified).
    ZH_CN

    # Chinese (Traditional).
    ZH_TW

    # Zulu.
    ZU

    # Chinese.
    ZH

    # Portuguese.
    PT

    # Volapük.
    VO
}

# The code designating a country/region, which generally follows ISO 3166-1 alpha-2 guidelines.
# If a territory doesn't have a country code value in the CountryCode enum, then it might be considered a subdivision
# of another country. For example, the territories associated with Spain are represented by the country code ES,
# and the territories associated with the United States of America are represented by the country code US.
enum CountryCode {
    # Afghanistan.
    AF

    # Åland Islands.
    AX

    # Albania.
    AL

    # Algeria.
    DZ

    # Andorra.
    AD

    # Angola.
    AO

    # Anguilla.
    AI

    # Antigua & Barbuda.
    AG

    # Argentina.
    AR

    # Armenia.
    AM

    # Aruba.
    AW

    # Ascension Island.
    AC

    # Australia.
    AU

    # Austria.
    AT

    # Azerbaijan.
    AZ

    # Bahamas.
    BS

    # Bahrain.
    BH

    # Bangladesh.
    BD

    # Barbados.
    BB

    # Belarus.
    BY

    # Belgium.
    BE

    # Belize.
    BZ

    # Benin.
    BJ

    # Bermuda.
    BM

    # Bhutan.
    BT

    # Bolivia.
    BO

    # Bosnia & Herzegovina.
    BA

    # Botswana.
    BW

    # Bouvet Island.
    BV

    # Brazil.
    BR

    # British Indian Ocean Territory.
    IO

    # Brunei.
    BN

    # Bulgaria.
    BG

    # Burkina Faso.
    BF

    # Burundi.
    BI

    # Cambodia.
    KH

    # Canada.
    CA

    # Cape Verde.
    CV

    # Caribbean Netherlands.
    BQ

    # Cayman Islands.
    KY

    # Central African Republic.
    CF

    # Chad.
    TD

    # Chile.
    CL

    # China.
    CN

    # Christmas Island.
    CX

    # Cocos (Keeling) Islands.
    CC

    # Colombia.
    CO

    # Comoros.
    KM

    # Congo - Brazzaville.
    CG

    # Congo - Kinshasa.
    CD

    # Cook Islands.
    CK

    # Costa Rica.
    CR

    # Croatia.
    HR

    # Cuba.
    CU

    # Curaçao.
    CW

    # Cyprus.
    CY

    # Czechia.
    CZ

    # Côte d’Ivoire.
    CI

    # Denmark.
    DK

    # Djibouti.
    DJ

    # Dominica.
    DM

    # Dominican Republic.
    DO

    # Ecuador.
    EC

    # Egypt.
    EG

    # El Salvador.
    SV

    # Equatorial Guinea.
    GQ

    # Eritrea.
    ER

    # Estonia.
    EE

    # Eswatini.
    SZ

    # Ethiopia.
    ET

    # Falkland Islands.
    FK

    # Faroe Islands.
    FO

    # Fiji.
    FJ

    # Finland.
    FI

    # France.
    FR

    # French Guiana.
    GF

    # French Polynesia.
    PF

    # French Southern Territories.
    TF

    # Gabon.
    GA

    # Gambia.
    GM

    # Georgia.
    GE

    # Germany.
    DE

    # Ghana.
    GH

    # Gibraltar.
    GI

    # Greece.
    GR

    # Greenland.
    GL

    # Grenada.
    GD

    # Guadeloupe.
    GP

    # Guatemala.
    GT

    # Guernsey.
    GG

    # Guinea.
    GN

    # Guinea-Bissau.
    GW

    # Guyana.
    GY

    # Haiti.
    HT

    # Heard & McDonald Islands.
    HM

    # Vatican City.
    VA

    # Honduras.
    HN

    # Hong Kong SAR.
    HK

    # Hungary.
    HU

    # Iceland.
    IS

    # India.
    IN

    # Indonesia.
    ID

    # Iran.
    IR

    # Iraq.
    IQ

    # Ireland.
    IE

    # Isle of Man.
    IM

    # Israel.
    IL

    # Italy.
    IT

    # Jamaica.
    JM

    # Japan.
    JP

    # Jersey.
    JE

    # Jordan.
    JO

    # Kazakhstan.
    KZ

    # Kenya.
    KE

    # Kiribati.
    KI

    # North Korea.
    KP

    # Kosovo.
    XK

    # Kuwait.
    KW

    # Kyrgyzstan.
    KG

    # Laos.
    LA

    # Latvia.
    LV

    # Lebanon.
    LB

    # Lesotho.
    LS

    # Liberia.
    LR

    # Libya.
    LY

    # Liechtenstein.
    LI

    # Lithuania.
    LT

    # Luxembourg.
    LU

    # Macao SAR.
    MO

    # Madagascar.
    MG

    # Malawi.
    MW

    # Malaysia.
    MY

    # Maldives.
    MV

    # Mali.
    ML

    # Malta.
    MT

    # Martinique.
    MQ

    # Mauritania.
    MR

    # Mauritius.
    MU

    # Mayotte.
    YT

    # Mexico.
    MX

    # Moldova.
    MD

    # Monaco.
    MC

    # Mongolia.
    MN

    # Montenegro.
    ME

    # Montserrat.
    MS

    # Morocco.
    MA

    # Mozambique.
    MZ

    # Myanmar (Burma).
    MM

    # Namibia.
    NA

    # Nauru.
    NR

    # Nepal.
    NP

    # Netherlands.
    NL

    # Netherlands Antilles.
    AN

    # New Caledonia.
    NC

    # New Zealand.
    NZ

    # Nicaragua.
    NI

    # Niger.
    NE

    # Nigeria.
    NG

    # Niue.
    NU

    # Norfolk Island.
    NF

    # North Macedonia.
    MK

    # Norway.
    NO

    # Oman.
    OM

    # Pakistan.
    PK

    # Palestinian Territories.
    PS

    # Panama.
    PA

    # Papua New Guinea.
    PG

    # Paraguay.
    PY

    # Peru.
    PE

    # Philippines.
    PH

    # Pitcairn Islands.
    PN

    # Poland.
    PL

    # Portugal.
    PT

    # Qatar.
    QA

    # Cameroon.
    CM

    # Réunion.
    RE

    # Romania.
    RO

    # Russia.
    RU

    # Rwanda.
    RW

    # St. Barthélemy.
    BL

    # St. Helena.
    SH

    # St. Kitts & Nevis.
    KN

    # St. Lucia.
    LC

    # St. Martin.
    MF

    # St. Pierre & Miquelon.
    PM

    # Samoa.
    WS

    # San Marino.
    SM

    # São Tomé & Príncipe.
    ST

    # Saudi Arabia.
    SA

    # Senegal.
    SN

    # Serbia.
    RS

    # Seychelles.
    SC

    # Sierra Leone.
    SL

    # Singapore.
    SG

    # Sint Maarten.
    SX

    # Slovakia.
    SK

    # Slovenia.
    SI

    # Solomon Islands.
    SB

    # Somalia.
    SO

    # South Africa.
    ZA

    # South Georgia & South Sandwich Islands.
    GS

    # South Korea.
    KR

    # South Sudan.
    SS

    # Spain.
    ES

    # Sri Lanka.
    LK

    # St. Vincent & Grenadines.
    VC

    # Sudan.
    SD

    # Suriname.
    SR

    # Svalbard & Jan Mayen.
    SJ

    # Sweden.
    SE

    # Switzerland.
    CH

    # Syria.
    SY

    # Taiwan.
    TW

    # Tajikistan.
    TJ

    # Tanzania.
    TZ

    # Thailand.
    TH

    # Timor-Leste.
    TL

    # Togo.
    TG

    # Tokelau.
    TK

    # Tonga.
    TO

    # Trinidad & Tobago.
    TT

    # Tristan da Cunha.
    TA

    # Tunisia.
    TN

    # Turkey.
    TR

    # Turkmenistan.
    TM

    # Turks & Caicos Islands.
    TC

    # Tuvalu.
    TV

    # Uganda.
    UG

    # Ukraine.
    UA

    # United Arab Emirates.
    AE

    # United Kingdom.
    GB

    # United States.
    US

    # U.S. Outlying Islands.
    UM

    # Uruguay.
    UY

    # Uzbekistan.
    UZ

    # Vanuatu.
    VU

    # Venezuela.
    VE

    # Vietnam.
    VN

    # British Virgin Islands.
    VG

    # Wallis & Futuna.
    WF

    # Western Sahara.
    EH

    # Yemen.
    YE

    # Zambia.
    ZM

    # Zimbabwe.
    ZW

    # Unknown Region.
    ZZ
}