shopify

v0.1.3

shopify v0.1.3 Shopify.Webhook

Summary

Functions

all(session, params \\ %{})

Requests all resources

count(session, params \\ %{})

Requests the resource count

create(session, new_resource)

Requests to create a new resource

delete(session, id)

Requests to delete a resource by id

find(session, id, params \\ %{})

Requests a resource by id

update(session, id, updated_resource)

Requests to update a resource by id

Functions

all(session, params \\ %{})

Requests all resources.

Returns {:ok, [resources]} or {:error, %Shopify.Error{}}

Parameters

  • session: A %Shopify.Session{} struct.
  • params: Any additional query params.

Examples 

iex> Shopify.session |> Shopify.Product.all
{:ok, [%Shopify.Product{}]}
count(session, params \\ %{})

Requests the resource count.

Returns {:ok, integer} or {:error, %Shopify.Error{}}

Parameters

  • session: A %Shopify.Session{} struct.
  • params: Any additional query params.

Examples 

iex> Shopify.session |> Shopify.Product.count
{:ok, 1}
create(session, new_resource)

Requests to create a new resource.

Returns {:ok, resource} or {:error, %Shopify.Error{}}

Parameters

  • session: A %Shopify.Session{} struct.
  • new_resource: A struct of the resource being created.

Examples 

iex> Shopify.session |> Shopify.Product.create(%Shopify.Product{})
{:ok, %Shopify.Product{}}
delete(session, id)

Requests to delete a resource by id.

Returns {:ok, resource} or {:error, %Shopify.Error{}}

Parameters

  • session: A %Shopify.Session{} struct.
  • id: The id of the resource.

Examples 

iex> Shopify.session |> Shopify.Product.delete(id)
{:ok, nil}
find(session, id, params \\ %{})

Requests a resource by id.

Returns {:ok, resource} or {:error, %Shopify.Error{}}

Parameters

  • session: A %Shopify.Session{} struct.
  • id: The id of the resource.
  • params: Any additional query params.

Examples 

iex> Shopify.session |> Shopify.Product.find(id)
{:ok, %Shopify.Product{}}
update(session, id, updated_resource)

Requests to update a resource by id.

Returns {:ok, resource} or {:error, %Shopify.Error{}}

Parameters

  • session: A %Shopify.Session{} struct.
  • id: The id of the resource.
  • updated_resource: A struct of the resource being updated.

Examples 

iex> Shopify.session |> Shopify.Product.update(id, %Shopify.Product{})
{:ok, %Shopify.Product{}}