ExShopify v0.2.0 ExShopify.FulfillmentEvent

A shipment of one or more items in an order.

Summary

Functions

Create a new fulfillment event

Receive a single fulfillment event

Receive a list of all fulfillment events

Types

fulfillment_event_plural()
fulfillment_event_plural() :: {:ok, [%ExShopify.FulfillmentEvent{address1: term, city: term, country: term, created_at: term, fulfillment_id: term, happend_at: term, id: term, latitude: term, longitude: term, message: term, order_id: term, province: term, shop_id: term, status: term, updated_at: term, zip: term}], %ExShopify.Meta{api_call_limit: term}}
fulfillment_event_singular()
fulfillment_event_singular() :: {:ok, %ExShopify.FulfillmentEvent{address1: term, city: term, country: term, created_at: term, fulfillment_id: term, happend_at: term, id: term, latitude: term, longitude: term, message: term, order_id: term, province: term, shop_id: term, status: term, updated_at: term, zip: term}, %ExShopify.Meta{api_call_limit: term}}

Functions

create(session, fulfillment_id, 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, integer | String.t, map) ::
  fulfillment_event_singular |
  ExShopify.Resource.error

Create a new fulfillment event.

Examples

iex> params = %ExShopify.FulfillmentEvent{status: 'in_transit'}

iex> ExShopify.FulfillmentEvent.create(session, 255858046, 450789469, params)
{:ok, fulfillment_event, meta}
delete(session, id, fulfillment_id, order_id)
delete(%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, integer | String.t) ::
  ExShopify.Resource.only_meta |
  ExShopify.Resource.error

Remove a fulfillment event.

Examples

iex> ExShopify.FulfillmentEvent.delete(session, 944956391, 255858046, 450789469)
{:ok, meta}
find(session, id, fulfillment_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, integer | String.t) ::
  fulfillment_event_singular |
  ExShopify.Resource.error

Receive a single fulfillment event.

Examples

iex> ExShopify.FulfillmentEvent.find(session, 944956394, 255858046, 450789469)
{:ok, fulfillment_event, meta}
list(session, fulfillment_id, 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, integer | String.t) ::
  fulfillment_event_plural |
  ExShopify.Resource.error

Receive a list of all fulfillment events.

Examples

iex> ExShopify.FulfillmentEvent.list(session, 255858046, 450789469)
{:ok, fulfillment_events, meta}