working-draft.md

Auth

FxC.signup(credentials)
    → jwt | err

FxC.login(credentials)
    → jwt | err

FxC.loginWith(authProvider, credentials)
    → jwt | err

FxC.logout()
    → success | err

Product catalog

In Process...

FxC.getProduct(id | slug)
    → { product }

FxC.getProducts(null | filters/categories/etc)
    → [{ products }]

FxC.search(query)
    → [{ products }]

getProducts Filters/Queries

The idea of this function is to be as flexible and forgiving as possible to return the most useful set of products. There are different levels of sugar:

• full, complex query object
• simplified query object [auto-detect fields]
• simple query string

Heavily inspired by WordPress’ Taxonomy querying.

Arguments

• condition (array|object) - Required, however if no relation is given, both relation and condition can be implied by passing an array of conditions or a single object at the root of the query [see examples below].
  • taxon|optionType (string) - Required. Taxonomy or OptionType name.
  • value (string|array) - Required. Taxonomy term(s) to filter by.
  • field (string) - Optional. Field to search taxonomy term by. Possible values: name, slug or any defined custom property. Default: slug.
  • include_children (bool) - Optional. Whether or not to include children for hierarchical taxonomies. Default: true.
  • operator (string) - Optional. Operator to test. Possible values are IN, NOT IN, AND, EXISTS and NOT EXISTS. Default: IN.
• relation (string) - Optional [only needed with multiple conditions]. Possible values: AND, OR. Default: AND.

All the below data can be passed to getProducts and will return the same result:

{
  taxon: 'gender',
  value: 'men'
}
-------
{
  gender: 'men'
}
-------
'gender=men'

Multiple filters are considered AND by default [i.e. select * from products where {condition} AND {condition}].

{
  relation: 'AND',
  conditions: [
    {
      taxon: 'gender',
      value: 'men'
    },
    {
      optionType: 'color',
      value: 'green'
    }
  ]
}
-------
[
  {
    gender: 'men'
  },
  {
    color: 'green'
  }
]
-------
'gender=men&color=green'

Cart

FxC.getCart()
    → { meta, [items]}

FxC.addToCart({item} | [{items}])
    → { cart } or success | err

FxC.removeFromCart({item} | [{items}])
    → { cart } or success | err

FxC.emptyCart()
    → { cart } or success | err

Checkout

FxC.checkout.getShippingMethods()
    → [{ methods }] | err [eg. shipping address not set]

FxC.checkout.setAddressData(address)
    → ?

FxC.checkout.setBillingData(data)
    → ?

FxC.checkout.addCreditCard(data)
    → ?

FxC.checkout.applyGiftCard(code)
    → success | err

FxC.checkout.applyPromoCode(code)
    → success | err

FxC.checkout.getCountries()
    → [{ countries }]

FxC.checkout.getStates(country)
    → [{ states }]

FxC.checkout.getCityFromZip(zip)
    → [{ city, state }]

FxC.checkout.reset()
    → success | err

FxC.checkout.finish()
    → success | err