ExShopify v0.2.0 ExShopify.Fulfillment

A shipment of one or more items in an order.

Summary

Functions

Cancel a fulfillment

Complete a fulfillment

Receive a count of all fulfillments

Create a new fulfillment

Receive a single fulfillment

Receive a list of all fulfillments

Transition a fulfillment from pending to open

Modify an existing fulfillment

Types

fulfillment_plural()
fulfillment_plural() :: {:ok, [%ExShopify.Fulfillment{created_at: term, id: term, line_items: term, order_id: term, receipt: term, status: term, tracking_company: term, tracking_numbers: term, tracking_urls: term, updated_at: term, variant_inventory_management: term}], %ExShopify.Meta{api_call_limit: term}}
fulfillment_singular()
fulfillment_singular() :: {:ok, %ExShopify.Fulfillment{created_at: term, id: term, line_items: term, order_id: term, receipt: term, status: term, tracking_company: term, tracking_numbers: term, tracking_urls: term, updated_at: term, variant_inventory_management: term}, %ExShopify.Meta{api_call_limit: term}}

Functions

cancel(session, id, order_id)
cancel(%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, integer | String.t) ::
  fulfillment_singular |
  ExShopify.Resource.error

Cancel a fulfillment.

Examples

iex> ExShopify.Fulfillment.cancel(session, 255858046, 450789469)
{:ok, fulfillment, meta}
complete(session, id, order_id)
complete(%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, integer | String.t) ::
  fulfillment_singular |
  ExShopify.Resource.error

Complete a fulfillment.

Examples

iex> ExShopify.Fulfillment.complete(session, 255858046, 450789469)
{:ok, fulfillment, meta}
count(session, order_id)
count(%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) ::
  ExShopify.Resource.count |
  ExShopify.Resource.error
count(session, order_id, params)
count(%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, map) ::
  ExShopify.Resource.count |
  ExShopify.Resource.error

Receive a count of all fulfillments.

Examples

iex> ExShopify.Fulfillment.count(session, 450789469)
{:ok, count, meta}
create(session, order_id, params)
create(%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, map) ::
  fulfillment_singular |
  ExShopify.Resource.error

Create a new fulfillment.

Examples

iex> params = %ExShopify.Fulfillment{
...>   tracking_number: "123456789010",
...>   tracking_company: "fed ex",
...>   line_items: [
...>     %ExShopify.LineItem{id: "466157049"},
...>     %ExShopify.LineItem{id: "518995019"},
...>     %ExShopify.LineItem{id: "703073504"}
...>   ]
...> }

iex> ExShopify.Fulfillment.create(session, 450789469, params)
{:ok, fulfillment, meta}
find(session, id, order_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, integer | String.t) ::
  fulfillment_singular |
  ExShopify.Resource.error
find(session, id, order_id, params)
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, integer | String.t, map) ::
  fulfillment_singular |
  ExShopify.Resource.error

Receive a single fulfillment.

Examples

iex> ExShopify.Fulfillment.find(session, 255858046, 450789469)
{:ok, fulfillment, meta}
list(session, order_id)
list(%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) ::
  fulfillment_plural |
  ExShopify.Resource.error
list(session, order_id, params)
list(%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, map) ::
  fulfillment_plural |
  ExShopify.Resource.error

Receive a list of all fulfillments.

Examples

Get a list of all fulfillments for an order.

iex> ExShopify.Fulfillment.list(session, 450789469)
{:ok, fulfillments, meta}

Get all fulfillments after the specified ID

iex> params = %{
...>   since_id: 255858046
...> }

iex> ExShopify.Fulfillment.list(session, 450789469, params)
{:ok, fulfillments, meta}
open(session, id, order_id)
open(%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, integer | String.t) ::
  fulfillment_singular |
  ExShopify.Resource.error

Transition a fulfillment from pending to open.

Examples

iex> ExShopify.Fulfillment.open(session, 255858046, 450789469)
{:ok, fulfillment, meta}
update(session, id, order_id, params)
update(%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, integer | String.t, map) ::
  fulfillment_singular |
  ExShopify.Resource.error

Modify an existing fulfillment.

Examples

iex> params = %{tracking_number: "987654321"}

iex> ExShopify.Fulfillment.update(session, 255858046, 450789469, params)
{:ok, fulfillment, meta}