shopify v0.4.0 Shopify.Order.Fulfillment

Link to this section Summary

Functions

all(session, top_id, params \\ %{})

Requests all resources

cancel(session, top_id, nest_id)

Request to cancel a fulfillment

complete(session, top_id, nest_id)

Request to mark a fulfillment as complete

count(session, top_id, params \\ %{})

Requests the resource count

create(session, top_id, new_resource)

Requests to create a new resource

find(session, top_id, nest_id, params \\ %{})

Requests a resource by id

open(session, top_id, nest_id)

Request to transition a fulfillment from pending to open

update(session, top_id, nest_id, updated_resource)

Requests to update a resource by id

Link to this section Functions

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

cancel(session, top_id, nest_id)

cancel(
  %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(),
  integer()
) ::
  {:ok,
   %Shopify.Order.Fulfillment{
     created_at: term(),
     id: term(),
     line_items: term(),
     location_id: term(),
     notify_customer: term(),
     order_id: term(),
     receipt: term(),
     service: term(),
     shipment_status: term(),
     status: term(),
     tracking_company: term(),
     tracking_number: term(),
     tracking_numbers: term(),
     tracking_url: term(),
     tracking_urls: term(),
     updated_at: term(),
     variant_inventory_management: term()
   }}
  | {:error, map()}

Request to cancel a fulfillment.

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 requested nested resource.

Examples

iex> Shopify.session |> Shopify.Fulfillment.cancel(1, 1)
{:ok, %Shopify.Response{}}

complete(session, top_id, nest_id)

complete(
  %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(),
  integer()
) ::
  {:ok,
   %Shopify.Order.Fulfillment{
     created_at: term(),
     id: term(),
     line_items: term(),
     location_id: term(),
     notify_customer: term(),
     order_id: term(),
     receipt: term(),
     service: term(),
     shipment_status: term(),
     status: term(),
     tracking_company: term(),
     tracking_number: term(),
     tracking_numbers: term(),
     tracking_url: term(),
     tracking_urls: term(),
     updated_at: term(),
     variant_inventory_management: term()
   }}
  | {:error, map()}

Request to mark a fulfillment as complete.

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 requested nested resource.

Examples

iex> Shopify.session |> Shopify.Fulfillment.complete(1, 1)
{:ok, %Shopify.Response{}}

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

create(session, top_id, new_resource)

Requests to create a new resource.

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

Parameters

session: A %Shopify.Session{} struct.
top_id: The id of the top-level resource.
new_resource: A struct of the resource being created.

Examples

iex> Shopify.session |> Shopify.Transaction.create(order_id)
{:ok, %Shopify.Response{}}

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

open(session, top_id, nest_id)

open(
  %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(),
  integer()
) ::
  {:ok,
   %Shopify.Order.Fulfillment{
     created_at: term(),
     id: term(),
     line_items: term(),
     location_id: term(),
     notify_customer: term(),
     order_id: term(),
     receipt: term(),
     service: term(),
     shipment_status: term(),
     status: term(),
     tracking_company: term(),
     tracking_number: term(),
     tracking_numbers: term(),
     tracking_url: term(),
     tracking_urls: term(),
     updated_at: term(),
     variant_inventory_management: term()
   }}
  | {:error, map()}

Request to transition a fulfillment from pending to open.

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 requested nested resource.

Examples

iex> Shopify.session |> Shopify.Fulfillment.open(1, 1)
{:ok, %Shopify.Response{}}

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