JSDoc: Interface: CommerceConnector

Source:

connectors/interfaces.js, line 14

Methods

addCartItem(cart, cartItem, opts) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Adds a cart item to cart.

Parameters:

Name	Type	Description
`cart`	module:@mobify/commerce-integrations/dist/types.Cart	The cart to add the cart item to.
`cartItem`	module:@mobify/commerce-integrations/dist/types.CartItem	The cart item to add.
`opts`	Object

Source:

connectors/interfaces.js, line 219

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Cart>

addCouponEntry(cart, couponEntry, opts) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Add a coupon to the cart by it's code.

Parameters:

Name	Type	Description
`cart`	module:@mobify/commerce-integrations/dist/types.Cart	The customer's cart.
`couponEntry`	Object	The coupon.
`opts`	Object	Options object.

Source:

connectors/interfaces.js, line 367

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Cart>

createCart(oldCcart, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Creates a new cart with an optional cart object.

Parameters:

Name	Type	Attributes	Description
`oldCcart`	module:@mobify/commerce-integrations/dist/types.Cart		The cart you'd like to migrate to the new cart
`opts`	Object	<optional>	object

Source:

connectors/interfaces.js, line 185

Throws:

Could not create cart.

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Cart>

createOrder(cart, opts) → {Promise.<module:@mobify/commerce-integrations/dist/types.Order>}

Create a new order using a given cart.

Parameters:

Name	Type	Description
`cart`	module:@mobify/commerce-integrations/dist/types.Cart	The customer's cart.
`opts`	Object

Source:

connectors/interfaces.js, line 326

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Order>

deleteCart(cartId, optsopt)

Deletes the given cart

Parameters:

Name	Type	Attributes	Description
`cartId`	String		The id of the cart you want to delete.
`opts`	Object	<optional>	object

Source:

connectors/interfaces.js, line 208

Throws:

Could not delete cart.

getCart(cartId, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Retrieve cart by id.

Parameters:

Name	Type	Attributes	Description
`cartId`	String		The id of the cart you want to retrieve
`opts`	Object	<optional>	object

Source:

connectors/interfaces.js, line 196

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Cart>

getCategories(ids, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.CategoryList>}

Returns multiple product Categories by their ids.

On supported backends this method will retrieve Categories in a single network call. Others may make a call per id to emulate the same behaviour.

Invalid ids are ignored and results are not guaranteed to be returned in the order requested.

Parameters:

Name	Type	Attributes	Description
`ids`	Array.<string>
`opts`	Object	<optional>	object

Source:

connectors/interfaces.js, line 161

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.CategoryList>

getCategory(id, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.Category>}

Get a product Category by id.

Parameters:

Name	Type	Attributes	Description
`id`	String
`opts`	Object	<optional>	object

Source:

connectors/interfaces.js, line 144

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Category>

getCustomer(id, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.Customer>}

Return a customer's details by id.

Parameters:

Name	Type	Attributes	Description
`id`	String		Customer Id
`opts`	Object	<optional>	Options object

Source:

connectors/interfaces.js, line 81

Throws:

Throw generic error if server has error.
Type module:@mobify/commerce-integrations/dist/errors.ServerError

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Customer>

getDefaultHeaders() → {Object.<String, String>}

Get the default headers that are sent with every request.

Source:

connectors/interfaces.js, line 20

Returns:

Type: Object.<String, String>

getOrder(id, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.Order>}

Get a single order by id.

Parameters:

Name	Type	Attributes	Description
`id`	String		The order id.
`opts`	Object	<optional>	Options object

Source:

connectors/interfaces.js, line 337

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Order>

getOrders(ids, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.OrderList>}

Get multiple orders by their ids.

On supported backends this method will retrieve orders in a single network call. Others may make a call per id to emulate the same behaviour.

Invalid ids are ignored and results are not guaranteed to be returned in the order requested.

Parameters:

Name	Type	Attributes	Description
`ids`	Array.<String>		The order ids.
`opts`	Object	<optional>	Options object

Source:

connectors/interfaces.js, line 354

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.OrderList>

getPaymentMethods(cart, opts) → {Promise.<Array.<module:@mobify/commerce-integrations/dist/types.PaymentMethod>>}

Get the available payment methods for the cart.

Parameters:

Name	Type	Description
`cart`	module:@mobify/commerce-integrations/dist/types.Cart	The customer's cart.
`opts`	Object

Source:

connectors/interfaces.js, line 316

Returns:

Type: Promise.<Array.<module:@mobify/commerce-integrations/dist/types.PaymentMethod>>

getProduct(id, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.Product>}

Get a single product by id.

Parameters:

Name	Type	Attributes	Description
`id`	String		The product id.
`opts`	Object	<optional>	Options object

Source:

connectors/interfaces.js, line 103

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Product>

getProducts(ids, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.ProductList>}

Get multiple products by their ids.

On supported backends this method will retrieve products in a single network call. Others may make a call per id to emulate the same behaviour.

Invalid ids are ignored and results are not guaranteed to be returned in the order requested.

Parameters:

Name	Type	Attributes	Description
`ids`	Array.<String>		The product ids.
`opts`	Object	<optional>	Options object

Source:

connectors/interfaces.js, line 120

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.ProductList>

getShippingMethods(cart, opts) → {Promise.<Array.<module:@mobify/commerce-integrations/dist/types.ShippingMethod>>}

Get all the available shipping methods given the cart details.

Parameters:

Name	Type	Description
`cart`	module:@mobify/commerce-integrations/dist/types.Cart	The cart to determinen avaialble shipping methods for.
`opts`	Object

Source:

connectors/interfaces.js, line 284

Returns:

Type: Promise.<Array.<module:@mobify/commerce-integrations/dist/types.ShippingMethod>>

getStore(id, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.Store>}

Get a Store (ie. a physical retail-outlet) by id. Includes addresses, opening hours, etc.

Parameters:

Name	Type	Attributes	Description
`id`	String		The id of the store
`opts`	Object	<optional>	Options object

Source:

connectors/interfaces.js, line 133

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Store>

Log a customer in and return their details.

On backends which support "guest login", credentials can be omitted to give you a guest session.

Parameters:

Name	Type	Description
`username`	String
`password`	String

Source:

connectors/interfaces.js, line 46

Throws:

Will throw an error if the username or password aren't provided for type registered.

Type

module:@mobify/commerce-integrations/dist/errors.InvalidArgumentError
Will throw an error if the customer credentials are incorrect.

Type

module:@mobify/commerce-integrations/dist/errors.ForbiddenError

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Customer>

logout() → {Promise.<undefined>}

Log a customer out.

Source:

connectors/interfaces.js, line 57

Throws:

Will throw an error if there was a server-side error.
Type module:@mobify/commerce-integrations/dist/errors.ServerError

Returns:

Type: Promise.<undefined>

refreshSession() → {Promise.<module:@mobify/commerce-integrations/dist/types.Customer>}

Refresh a session token, on backends that support refresh.

Source:

connectors/interfaces.js, line 68

Throws:

Will throw an error if authorization credentials are incorrect
Type module:@mobify/commerce-integrations/dist/errors.ForbiddenError

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Customer>

removeCartItem(cart, cartItemId, opts) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Remove a cart item from the cart.

Parameters:

Name	Type	Description
`cart`	module:@mobify/commerce-integrations/dist/types.Cart	The cart to remove the cart item from.
`cartItemId`	String	The id of the cart item to remove.
`opts`	Object

Source:

connectors/interfaces.js, line 230

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Cart>

removeCouponEntry(cart, couponEntryId, opts) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Removes a coupon from the cart by its coupon entry id.

Parameters:

Name	Type	Description
`cart`	module:@mobify/commerce-integrations/dist/types.Cart	The customer's cart.
`couponEntryId`	Object	The coupon entry id.
`opts`	Object	Options object.

Source:

connectors/interfaces.js, line 380

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Cart>

searchProducts(productSearchRequest, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.ProductSearch>}

Search for products, given a productSearchRequest object.

Parameters:

Name	Type	Attributes	Description
`productSearchRequest`	module:@mobify/commerce-integrations/dist/types.ProductSearchRequest		Search query
`opts`	Object	<optional>	Options object

Source:

connectors/interfaces.js, line 92

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.ProductSearch>

searchStores(storeSearchRequest, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.StoreSearchResult>}

Searches for Stores (ie. physical retail-outlets).

Parameters:

Name	Type	Attributes	Description
`storeSearchRequest`	module:@mobify/commerce-integrations/dist/types.StoreSearchRequest
`opts`	Object	<optional>	Options object

Source:

connectors/interfaces.js, line 172

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.StoreSearchResult>

setBillingAddress(cart, billingAddress, opts) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Set the billing address on the cart.

Parameters:

Name	Type	Description
`cart`	module:@mobify/commerce-integrations/dist/types.Cart	The cart to update the billing address for.
`billingAddress`	module:@mobify/commerce-integrations/dist/types.OrderAddress	The new or modified address.
`opts`	Object

Source:

connectors/interfaces.js, line 263

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Cart>

setCustomerInformation(cart, customerInformation, opts) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Set the customer information.

Parameters:

Name	Type	Description
`cart`	module:@mobify/commerce-integrations/dist/types.Cart	The customer's cart.
`customerInformation`	module:@mobify/commerce-integrations/dist/types.CustomerInformation	The new or modified customer information.
`opts`	Object

Source:

connectors/interfaces.js, line 306

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Cart>

setDefaultHeaders(headers)

Set the default headers that are sent with every request.

Parameters:

Name	Type	Description
`headers`	Object.<String, String>

Source:

connectors/interfaces.js, line 29

setPayment(cart, payment, opts) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Add a supported payment type to the cart

Parameters:

Name	Type	Description
`cart`	module:@mobify/commerce-integrations/dist/types.Cart	The cart to remove the payment from.
`payment`	module:@mobify/commerce-integrations/dist/types.Payment	The payment to add.
`opts`	Object

Source:

connectors/interfaces.js, line 274

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Cart>

setShippingAddress(cart, shippingAddress, opts) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Set the shipping address on the cart.

Parameters:

Name	Type	Description
`cart`	module:@mobify/commerce-integrations/dist/types.Cart	The cart to update the shipping address for.
`shippingAddress`	module:@mobify/commerce-integrations/dist/types.OrderAddress	The new or modified address.
`opts`	Object

Source:

connectors/interfaces.js, line 252

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Cart>

setShippingMethod(cart, shippingMethod, opts) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Set the shipping method for the cart.

Parameters:

Name	Type	Description
`cart`	module:@mobify/commerce-integrations/dist/types.Cart	The cart to set the shipping method for.
`shippingMethod`	module:@mobify/commerce-integrations/dist/types.ShippingMethod	The shipping method to set.
`opts`	Object

Source:

connectors/interfaces.js, line 295

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Cart>

updateCartItem(cart, cartItem, opts) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Update an existing cart item in the cart.

Parameters:

Name	Type	Description
`cart`	module:@mobify/commerce-integrations/dist/types.Cart	The cart to containing the cart item to update.
`cartItem`	module:@mobify/commerce-integrations/dist/types.CartItem	The cart item to update.
`opts`	Object

Source:

connectors/interfaces.js, line 241

Returns:

Type: Promise.<module:@mobify/commerce-integrations/dist/types.Cart>

Interface: CommerceConnector

Methods

addCartItem(cart, cartItem, opts) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Parameters:

Returns:

addCouponEntry(cart, couponEntry, opts) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Parameters:

Returns:

createCart(oldCcart, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Parameters:

Throws:

Returns:

createOrder(cart, opts) → {Promise.<module:@mobify/commerce-integrations/dist/types.Order>}

Parameters:

Returns:

deleteCart(cartId, optsopt)

Parameters:

Throws:

getCart(cartId, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Parameters:

Returns:

getCategories(ids, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.CategoryList>}

Parameters:

Returns:

getCategory(id, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.Category>}

Parameters:

Returns:

getCustomer(id, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.Customer>}

Parameters:

Throws:

Returns:

getDefaultHeaders() → {Object.<String, String>}

Returns:

getOrder(id, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.Order>}

Parameters:

Returns:

getOrders(ids, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.OrderList>}

Parameters:

Returns:

getPaymentMethods(cart, opts) → {Promise.<Array.<module:@mobify/commerce-integrations/dist/types.PaymentMethod>>}

Parameters:

Returns:

getProduct(id, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.Product>}

Parameters:

Returns:

getProducts(ids, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.ProductList>}

Parameters:

Returns:

getShippingMethods(cart, opts) → {Promise.<Array.<module:@mobify/commerce-integrations/dist/types.ShippingMethod>>}

Parameters:

Returns:

getStore(id, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.Store>}

Parameters:

Returns:

login(username, password) → {Promise.<module:@mobify/commerce-integrations/dist/types.Customer>}

Parameters:

Throws:

Returns:

logout() → {Promise.<undefined>}

Throws:

Returns:

refreshSession() → {Promise.<module:@mobify/commerce-integrations/dist/types.Customer>}

Throws:

Returns:

removeCartItem(cart, cartItemId, opts) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Parameters:

Returns:

removeCouponEntry(cart, couponEntryId, opts) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Parameters:

Returns:

searchProducts(productSearchRequest, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.ProductSearch>}

Parameters:

Returns:

searchStores(storeSearchRequest, optsopt) → {Promise.<module:@mobify/commerce-integrations/dist/types.StoreSearchResult>}

Parameters:

Returns:

setBillingAddress(cart, billingAddress, opts) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}

Parameters:

Returns:

setCustomerInformation(cart, customerInformation, opts) → {Promise.<module:@mobify/commerce-integrations/dist/types.Cart>}