ExShopify v0.2.0 ExShopify.Discount

Applicable discounts that can be applied to the order.

Summary

Functions

Create a discount

Delete a discount

Disable a discount

Enable a discount

Retrieve a discount

List all discounts

Types

discount_plural()
discount_plural() :: {:ok, [%ExShopify.Discount{applies_once: term, applies_once_per_customer: term, applies_to_id: term, applies_to_resource: term, code: term, discount_type: term, ends_at: term, id: term, minimum_order_amount: term, starts_at: term, status: term, times_used: term, usage_limit: term, value: term}], %ExShopify.Meta{api_call_limit: term}}
discount_singular()
discount_singular() :: {:ok, %ExShopify.Discount{applies_once: term, applies_once_per_customer: term, applies_to_id: term, applies_to_resource: term, code: term, discount_type: term, ends_at: term, id: term, minimum_order_amount: term, starts_at: term, status: term, times_used: term, usage_limit: term, value: term}, %ExShopify.Meta{api_call_limit: term}}

Functions

create(session, params)
create(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, map) ::
  discount_singular |
  ExShopify.Resource.error

Create a discount.

Examples

Create a discount code “balderdash” that gives the buyer 15% off

iex> params = %ExShopify.Discount{
...>   discount_type: "percentage",
...>   value: "15.0",
...>   code: "balderdash"
...> }

iex> ExShopify.Discount.create(session, params)
{:ok, discount, meta}

Create a discount code “fortunamajor” that gives the buyer $10 off if their order total exceeds $40

iex> params = %ExShopify.Discount{
...>   discount_type: "fixed_amount",
...>   value: "10.00",
...>   code: "fortunamajor",
...>   minimum_order_amount: "40.00"
...> }

iex> ExShopify.Discount.create(session, params)
{:ok, discount, meta}

Create a free shipping discount code “quidagis?” that can be used up to 20 times by shoppers during a specific time period

iex> params = %ExShopify.Discount{
...>   discount_type: "shipping",
...>   code: "quidagis",
...>   starts_at: "2015-08-23T00:00:00-04:00",
...>   ends_at: "2015-08-27T23:59:59-04:00",
...>   usage_limit: 20
...> }

iex> ExShopify.Discount.create(session, params)
{:ok, discount, meta}
delete(session, 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) ::
  ExShopify.Resource.only_meta |
  ExShopify.Resource.error

Delete a discount.

iex> ExShopify.Discount.delete(session, 680866)
{:ok, meta}
disable(session, id)
disable(%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.only_meta |
  ExShopify.Resource.error

Disable a discount.

Examples

iex> ExShopify.Discount.disable(session, 680866)
{:ok, meta}
enable(session, id)
enable(%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) ::
  discount_singular |
  ExShopify.Resource.error

Enable a discount.

Examples

iex> ExShopify.Discount.enable(session, 949676421)
{:ok, discount, meta}
find(session, 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) ::
  discount_singular |
  ExShopify.Resource.error

Retrieve a discount.

Examples

iex> ExShopify.Discount.find(session, 680866)
{:ok, discount, meta}
list(session)
list(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}) ::
  discount_plural |
  ExShopify.Resource.error
list(session, params)
list(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, map) ::
  discount_plural |
  ExShopify.Resource.error

List all discounts.

Examples

iex> ExShopify.Discount.list(session)
{:ok, discounts, meta}