shopify

v0.4.0

shopify v0.4.0 Shopify.MarketingEvent

Link to this section 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

create_multiple_engagements(session, marketing_event_id, engagements)

Alias for Shopify.MarketingEvent.Engagement.create_multiple/3

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

Link to this section Functions

Link to this function all(session, params \\ %{})

Requests all resources.

Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}

Parameters

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

Examples 

iex> Shopify.session |> Shopify.Product.all
{:ok, %Shopify.Response{}}
Link to this function count(session, params \\ %{})

Requests the resource count.

Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}

Parameters

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

Examples 

iex> Shopify.session |> Shopify.Product.count
{:ok, %Shopify.Response{}}
Link to this function create(session, new_resource) 
create(
  %Shopify.Session{
    access_token: term(),
    api_key: term(),
    api_version: term(),
    client_id: term(),
    client_secret: term(),
    password: term(),
    req_opts: term(),
    shop_name: term(),
    type: term()
  },
  map()
) :: {:ok, list()} | {:error, map()}

Requests to create a new resource.

Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}

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.Response{}}
Link to this function create_multiple_engagements(session, marketing_event_id, engagements) 
create_multiple_engagements(
  %Shopify.Session{
    access_token: term(),
    api_key: term(),
    api_version: term(),
    client_id: term(),
    client_secret: term(),
    password: term(),
    req_opts: term(),
    shop_name: term(),
    type: term()
  },
  integer(),
  [
    %Shopify.MarketingEvent.Engagement{
      ad_spend: term(),
      clicks_count: term(),
      comments_count: term(),
      favorites_count: term(),
      impressions_count: term(),
      is_cumulative: term(),
      occurred_on: term(),
      shares_count: term(),
      views_count: term()
    }
  ]
) :: {:ok, Shopify.Response.t()} | {:error, Shopify.Response.t()}

Alias for Shopify.MarketingEvent.Engagement.create_multiple/3

Link to this function delete(session, id)

Requests to delete a resource by id.

Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}

Parameters

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

Examples 

iex> Shopify.session |> Shopify.Product.delete(id)
{:ok, %Shopify.Response{}}
Link to this function find(session, id, params \\ %{})

Requests a resource by id.

Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}

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.Response{}}
Link to this function update(session, id, updated_resource)

Requests to update a resource by id.

Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}

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.Response{}}