shopify v0.2.0 Shopify.Country.Province
Link to this section Summary
Functions
Requests all resources
Requests the resource count
Requests a resource by id
Requests to update a resource by id
Link to this section Functions
Link to this function
all(session, top_id, params \\ %{})
Requests all resources.
Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}
Parameters
- session: A
%Shopify.Session{}struct. - top_id: The id of the top-level resource.
- params: Any additional query params.
Examples
iex> Shopify.session |> Shopify.Transaction.all(order_id)
{:ok, %Shopify.Response{}}
Link to this function
count(session, top_id, params \\ %{})
Requests the resource count.
Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}
Parameters
- session: A
%Shopify.Session{}struct. - top_id: The id of the top-level resource.
- params: Any additional query params.
Examples
iex> Shopify.session |> Shopify.Transaction.count(order_id)
{:ok, %Shopify.Response{}}
Link to this function
find(session, top_id, nest_id, params \\ %{})
Requests a resource by id.
Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Response{}}
Parameters
- session: A
%Shopify.Session{}struct. - top_id: The id of the top-level resource.
- nest_id: The id of the nest-level resource.
- params: Any additional query params.
Examples
iex> Shopify.session |> Shopify.Transaction.find(order_id, transaction_id)
{:ok, %Shopify.Response{}}
Link to this function
update(session, top_id, nest_id, updated_resource)
Requests to update a resource by id.
Returns {:ok, %Shopify.Response{}} or {:error, %Shopify.Error{}}
Parameters
- session: A
%Shopify.Session{}struct. - top_id: The id of the top-level resource.
- nest_id: The id of the nested-level resource.
- updated_resource: A struct of the resource being updated.
Examples
iex> Shopify.session |> Shopify.CustomerAddress.update(customer_id, address_id)
{:ok, %Shopify.Response{}}