Admin-API/ext/localization.graphql

# Represents the value captured by a localization extension. Localization extensions are additional fields required by certain countries on international orders.
# For example, some countries require additional fields for customs information or tax identification numbers.
type LocalizationExtension {
    # Country ISO 3166-1 alpha-2 code.
    countryCode: CountryCode!

    # The localized extension keys that are allowed.
    key: LocalizationExtensionKey!

    # The purpose of this localization extension.
    purpose: LocalizationExtensionPurpose!

    # The localized extension title.
    title: String!

    # The value of the field.
    value: String!
}

# An auto-generated type for paginating through multiple LocalizationExtensions.
type LocalizationExtensionConnection {
    # A list of edges.
    edges: [LocalizationExtensionEdge!]!

    # A list of the nodes contained in LocalizationExtensionEdge.
    nodes: [LocalizationExtension!]!

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

# An auto-generated type which holds one LocalizationExtension and a cursor during pagination.
type LocalizationExtensionEdge {
    # A cursor for use in pagination.
    cursor: String!

    # The item at the end of LocalizationExtensionEdge.
    node: LocalizationExtension!
}