ExShopifySchema

View Source

A collection of Elixir schemas for Shopify resources.

Installation

The package can be installed by adding ex_shopify_schema to your list of dependencies in mix.exs:

def deps do
  [
    {:ex_shopify_schema, "~> <SHOPIFY_VERSION>.patch"}
    # for example: {:ex_shopify_schema, "~> 2025.4.2"}
  ]
end

Documentation can be found at https://hexdocs.pm/ex_shopify_schema.

Configuration

You can configure how Ecto types are handled by adding the following to your config.exs:

config :ex_shopify_schema, :ecto_types,
  enum: :atom,  # or :string
  uri: :struct  # or :string

Available Options

  • :enum - Controls how GraphQL enum values are handled:

    • :atom (default) - Enum values are treated as atoms
    • :string - Enum values are treated as strings
  • :uri - Controls how URI/URL fields are handled:

    • :struct (default) - URI values are returned as URI.t() structs
    • :string - URI values are returned as plain strings