What's happenin'?
How can I help you today?

My Account
Login | Services | Support

  • @goverstreet:

miniShop2

Quick Start Guide

Introduction

About miniShop2

miniShop2 is a free add-on for MODX Revolution that was originally developed by Basil Naumkin (aka Bezumkin.)

Since it was originally developed in Russia, some users have had difficulties translating the quick start guide and video.  Hopefully this helps clear things up for other developers.

Table of Contents

Getting Started

Installation

Install miniShop2 & pdoTools in Package Management.  miniShop2 will try to automatically download and install pdoTools, though if it fails, make sure it is also added.  You will also need phpThumbOf in order to use thumbnails.

Setting Up PayPal

Component Settings

Payments

Create Payment Types (PayPal / CC, Check / Money Order, Cash, etc.)

Deliveries

Create Deliveries (Ground shipping, pickup, etc.) and choose what payment types are allowed for each

Statuses, Vendors, and Links of Goods are all optional features.

Additional System Settings

Friendly URLS

Make sure Friendly URLs are enabled.  Otheriwse it won't work at the checkout.

Formatting

Developers for US sites most likely need to change the formatting options of the prices, weight, and dates.

Prices

[2, ".", ","]

Weight

 [3, ".", ","]

Date

%m/%d/%y <span class="gray">%H:%M</span>

PayPal

ms2_payment_paypal_api_url

Default: https://api-3t.paypal.com/nvp
Sandbox: https://api-3t.sandbox.paypal.com/nvp 

ms2_payment_paypal_checkout_url

Default: https://www.paypal.com/webscr?cmd=_express-checkout&token=
Sandbox: https://www.sandbox.paypal.com/webscr?cmd=_express-checkout&token= 

API

Add PayPal User, Password, and Signature from PayPal's API Credentials

Cancel & Success IDs

Set to the appropriate pages created

Media Sources

If you use media sources for your products, be sure to set the ID of your default media source.

 

Templates Required

Category

Add msProducts Snippet to template

Product

Add msProduct.content Chunk to template

Other Pages

Cart, Payment, Success, and Cancelled pages can all be basic text pages with the snippet added to the content (or in custom templates if you prefer.)  Be sure to disabled richtext.

Pages Required

Overview
  • Category
  • Product
  • Cart
  • Payment
  • Success
  • Cancel
Category Page

Create Products Category container with the custom class and the "Category" template.  This works similar to Shaun McCormick's "Articles" container.

Product Page

Add a product or two.  This also works like Articles, with a few different options.

  • Price: Add current price of product
  • Old Price (Optional): Add old price of product
  • Weight (Optional): If you figure in shipping costs, add the weight of each individual unit.
  • Article (Optional):  This is if you have any blogs or other pages attached to it.

Cart Page

Add msCart Snippet to Cart template.  Create a page where your cart / summary of products will go.  You'll need to a link to the payment page.  You can create a custom chunk for the outer wrapper (tplOuter) or listed item (tplRow.)  Default chunks are installed under the "miniShop2" chunk category.

Payment Page

Add msOrder Snippet

Success Page

No snippets required

Cancel Page

No Snippets required

Additional Notes

Sub-Directories

miniShop2 cannot be installed in sub-directories without some modifications.

Snippets

Display Section

msCart

Parameters

  • includeTVs
  • includeThumbs
  • tplEmpty
  • tplOuter
  • tplRow

msGallery

  • limit
  • offset
  • product
  • showLog
  • sortby
  • sortdir
  • toPlaceholder
  • tplEmpty
  • tplOuter
  • tplRow

msGetOrder

  • includeTVs
  • includeThumbs
  • tplEmpty
  • tplOuter
  • tplRow
  • msMiniCart
  • tpl

msOptions

  • name
  • outputSeparator
  • product
  • selected
  • tplEmpty
  • tplOuter
  • tplRow

msOrder

  • tplDelivery
  • tplEmpty
  • tplOuter
  • tplPayment
  • tplSuccess

msProducts

  • class
  • depth
  • fastMode
  • includeContent
  • includeTVs
  • includeThumbs
  • limit
  • link
  • master
  • offset
  • ouputSeparator
  • parents
  • resources
  • showDeleted
  • showHidden
  • showLog
  • showUnpublished
  • showZeroPrice
  • slave
  • sortby
  • sortdir
  • toPlaceholder
  • tpl
  • tvPrefix
  • where

Chunks

Templates and Layouts

Plugin

Stylize the Cart

Blogs

Most Popular
Related
Recent

Get Updates

Want to get more information?

* indicates required