shopify v0.4.0 Shopify

Link to this section Summary

Functions

Removes .myshopify.com (returned by queries to shopify) from shop names

Create a new Shopify session for a private app using Application config

Create a new Shopify session for an OAuth app using the provided shop name. This will include your Application.config client_id and client_secret in the session. This should only be used when attempting to generate new access tokens

Create a new Shopify session for an OAuth app using the provided config

Create a new Shopify session for a private app using the provided config

Link to this section Functions

Link to this function scrub_shop_name(name)

Removes .myshopify.com (returned by queries to shopify) from shop names

Examples

iex> Shopify.scrub_shop_name("shop-name.myshopify.com")
"shop-name"

iex> Shopify.scrub_shop_name("shop-name")
"shop-name"

Create a new Shopify session for a private app using Application config.

Returns %Shopify.Session{}

Examples

iex> with %Shopify.Session{} <- Shopify.session, do: :passed
:passed
Link to this function session(shop_name)

Create a new Shopify session for an OAuth app using the provided shop name. This will include your Application.config client_id and client_secret in the session. This should only be used when attempting to generate new access tokens.

Returns %Shopify.Session{}

Examples

iex> with %Shopify.Session{shop_name: "shop_name"} <- Shopify.session("shop_name"), do: :passed
:passed
Link to this function session(shop_name, access_token)

Create a new Shopify session for an OAuth app using the provided config.

Returns %Shopify.Session{}

Examples

iex> Shopify.session("shop-name", "access-token")
%Shopify.Session{
  access_token: "access-token",
  api_key: nil,
  api_version: nil,
  client_id: nil,
  client_secret: nil,
  password: nil,
  shop_name: "shop-name",
  type: :oauth
}
Link to this function session(shop_name, api_key, password)

Create a new Shopify session for a private app using the provided config.

Returns %Shopify.Session{}

Examples

iex> Shopify.session("my-shop-name", "my-api-key", "my-password")
%Shopify.Session{
  access_token: nil,
  api_key: "my-api-key",
  api_version: nil,
  client_id: nil,
  client_secret: nil,
  password: "my-password",
  shop_name: "my-shop-name",
  type: :basic
}