node package manager

trailpack-proxy-cart

Cart - Trailpack for Proxy Engine

trailpack-proxy-cart

NPM version Build status Dependency Status Code Climate

Node.js eCommerce built for speed, scalability, flexibility, and love from Cali Style

Proxy Cart is the eCommerce component for Proxy Engine. Connect your own Merchant Processor, Shipping Provider, Fulfillment Service, Tax Provider, and import your products. Attach it to Proxy Engine and start building with Proxy CMS!

Dependencies

Proxy Engine

Repo Build Status (edge)
trailpack-proxy-engine Build status

Supported ORMs

Repo Build Status (edge)
trailpack-sequelize Build status

Supported Webserver

Repo Build Status (edge)
trailpack-express Build status

Install

$ npm install --save trailpack-proxy-cart

Configure

// config/main.js 
module.exports = {
  packs: [
    // ... other trailpacks 
    require('trailpack-proxy-cart')
  ]
}

Shops

A shop represents a physical location that sells a product. When taxes and shipping are calculated per product, they are calculated by the nearest shop to the destination of an order. This means that the same product can be sold in multiple stores and shipped from different locations which may effect shipping and tax rates.

Products

A Product is a Physical or Digital item.

Product Variants

A Product Variant is a variation of a product denoted by a unique Stock Keeping Unit (SKU)

Product Images

A Product Image is an image that is associated directly with a product and sometimes a product variant.

Product Reviews

A Product Review is input from a customer with a history of purchasing a product.

Metadata

A Metadata is additional information about a product, customer, or review that is not constrained by the parent model.

Collections

A Collection is a grouping of like items, such as products, customers, and shipping zones.

Tags

A Tag is a searching marker for a customer or product.

Customers

A Customer is a user or guest.

Carts

A Cart is a bucket that holds products and data until an order is placed.

Orders

An Order is a bucket that holds products and data and the transactions of purchases and fulfillment.

Fulfillment

A Fulfillment is a shipping transaction for an order.

Transactions

A Transaction is a representation of a purchasing event.

Gift Cards

A Gift Card is an alternate payment method that acts as a customer source.

Discounts

A Discount is a value or percent off of a product, shipping cost, or total order applied by meeting criteria.

Coupon

A redeemable discount that has a code.

Subscriptions

A Subscription is the reoccurring of an order based on time period.

Shipping Zones

A Shipping Zone is a geographical area that may override shipping and tax costs.

Shipping Restrictions

A Shipping Restriction is a geographical restriction on the shipping of certain products.

Usage

Controllers

CustomerController

Handles Customer operations ##### CustomerController.create

CustomerController.update
CustomerController.findOne
CustomerController.uploadCSV
CustomerController.processUpload

CartController

Handles Cart operations ##### CartController.create

CartController.checkout
CartController.addItems
CartController.removeItems
CartController.clear

OrderController

Handles Order operations

ProductController

Handles Product operations ##### ProductController.findOne

ProductController.addProduct
ProductController.addProducts
ProductController.updateProduct
ProductController.updateProducts
ProductController.removeProduct
ProductController.removeProducts
ProductController.removeVariant
ProductController.removeVariants
ProductController.removeImage
ProductController.removeImages
ProductController.uploadCSV
ProductController.processUpload
ProductController.uploadMetaCSV
ProductController.processMetaUpload

ShopController

Handles Shop operations

SubscriptionController

Handles Subscription operations

TransactionController

Handles Transaction operations

Services

CartService

CollectionService

CouponService

CustomerService

CustomerCSVService

DiscountService

FulfillmentService

GiftCardService

OrderService

ProductService

ProductCsvService

ProxyCartService

ShippingService

ShopService

SubscriptionService

TaxService

TransactionService

Models

Address

Cart

City

Collection

Country

County

Coupon

Customer

CustomerAddress

CustomerUpload

Discount

Fulfillment

FulfillmentEvent

GiftCard

ItemCollection

ItemMetadata

ItemTag

Metadata

Order

OrderItem

Product

ProductImage

ProductReview

ProductVariant

ProductUpload

ProductMetaUpload

Province

Refund

ShippingRestriction

ShippingZone

Shop

Subscription

Tag

Transaction