ExShopify v0.2.0 ExShopify.Location

A geographical location where your stores, headquarters, and/or pop-up stores exist.

Summary

Functions

Receive a single location

Receive a list of all locations

Types

location_plural()
location_plural() :: {:ok, [%ExShopify.Location{address1: term, address2: term, city: term, country: term, created_at: term, id: term, name: term, phone: term, province: term, updated_at: term, zip: term}], %ExShopify.Meta{api_call_limit: term}}
location_singular()
location_singular() :: {:ok, %ExShopify.Location{address1: term, address2: term, city: term, country: term, created_at: term, id: term, name: term, phone: term, province: term, updated_at: term, zip: term}, %ExShopify.Meta{api_call_limit: term}}

Functions

find(session, id)
find(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, integer | String.t) ::
  location_singular |
  ExShopify.Resource.error

Receive a single location.

Examples

iex> ExShopify.Location.find(session, 487838322)
{:ok, locations, meta}
list(session)
list(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}) ::
  location_plural |
  ExShopify.Resource.error

Receive a list of all locations.

Examples

iex> ExShopify.Location.list(session)
{:ok, locations, meta}