Jump to content
Gadgetto

SnipWire - Snipcart integration for ProcessWire

Recommended Posts

Well, the first thing that springs to mind is: Can I add a quantity in the frontend? I don't see a possibility to change the quantity either in the cart (select or number input field, or stepper).

btw: I got a JS error re: jQuery - I had to remove the jQuery integrity hash from the module settings

Share this post


Link to post
Share on other sites
2 minutes ago, dragan said:

Well, the first thing that springs to mind is: Can I add a quantity in the frontend? I don't see a possibility to change the quantity either in the cart (select or number input field, or stepper).

btw: I got a JS error re: jQuery - I had to remove the jQuery integrity hash from the module settings

?

1793549077_Bildschirmfoto2020-02-07um13_33_37.thumb.png.70d1a3fba0cb0fdb504259121012ff0a.png

3 minutes ago, dragan said:

I got a JS error re: jQuery - I had to remove the jQuery integrity hash from the module settings

Could you please post the complete JS error?

Share this post


Link to post
Share on other sites

OK, I guess it has to do with what you mentioned earlier: I am using delayed output... Guess I have to rewrite the test templates.

Share this post


Link to post
Share on other sites
5 minutes ago, dragan said:

OK, I guess it has to do with what you mentioned earlier: I am using delayed output... Guess I have to rewrite the test templates.

It should be no matter which output strategy you use.

Share this post


Link to post
Share on other sites

hmmm, so I rewrote the templates, and made sure the three required frontend assets are loaded (Snipcart JS + CSS  + jQuery), but it looks completely un-styled, and there is no quantity-stepper anywhere.

1957351695_Screenshot_2020-02-07AxolotlJuicer.thumb.png.aaf349c6ef6f45f7816c5ac40561eccc.png

582391400_Screenshot_2020-02-07AxolotlJuicer(1).png.030abcec2b0703a9b9829e19538b7fd5.png

I've even added UIKit CSS + JS now... it looks a bit different, but still... far from the screens you posted. Maybe I'll try on a new PW installation with the regular profile. While it's certainly nice that you provided such a test-setup with templates and dummy products, I think it shouldn't be dependant on what site profile you used when installing PW. If I inspect certain elements that have classed, I don't see any style definitions.

But maybe the problem is elsewhere... here are the (probably) relevant settings on the product page:

593721225_Screenshot_2020-02-07EditPageAxolotlJuicerpwbigtest.thumb.png.f83e22820a36ca63431ea84d47f10fd6.png

But I guess what I see is "stackable" variety... When I inspect the button, I see:

<button class="snipcart-add-item uk-button uk-button-primary" title="Add to cart" aria-label="Add item to cart" data-item-name="Axolotl Juicer" data-item-id="JUICER_123" data-item-price="{&quot;chf&quot;:&quot;10&quot;,&quot;eur&quot;:&quot;8.50&quot;,&quot;usd&quot;:&quot;10&quot;}" data-item-url="http://pw.test/en/snipcart-shop/axolotl-juicer/" data-item-description="Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur." data-item-image="http://pw.test/site/assets/files/23131/beer3.65x65-hidpi.jpg" data-item-metadata="{&quot;id&quot;:23131,&quot;created&quot;:1581076192,&quot;modified&quot;:1581078285,&quot;published&quot;:1581076192,&quot;created_users_id&quot;:41,&quot;modified_users_id&quot;:41}" data-item-quantity="1" data-item-quantity-step="1" data-item-stackable="false" data-item-taxable="true" data-item-taxes="CH" data-item-has-taxes-included="true" data-item-shippable="true"><span uk-icon="icon: cart" class="uk-icon"></span> Add to cart</button>

but no quantity stepper markup anywhere.

Share this post


Link to post
Share on other sites
4 hours ago, dragan said:

But I guess what I see is "stackable" variety... When I inspect the button, I see:


<button class="snipcart-add-item uk-button uk-button-primary" title="Add to cart" aria-label="Add item to cart" data-item-name="Axolotl Juicer" data-item-id="JUICER_123" data-item-price="{&quot;chf&quot;:&quot;10&quot;,&quot;eur&quot;:&quot;8.50&quot;,&quot;usd&quot;:&quot;10&quot;}" data-item-url="http://pw.test/en/snipcart-shop/axolotl-juicer/" data-item-description="Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur." data-item-image="http://pw.test/site/assets/files/23131/beer3.65x65-hidpi.jpg" data-item-metadata="{&quot;id&quot;:23131,&quot;created&quot;:1581076192,&quot;modified&quot;:1581078285,&quot;published&quot;:1581076192,&quot;created_users_id&quot;:41,&quot;modified_users_id&quot;:41}" data-item-quantity="1" data-item-quantity-step="1" data-item-stackable="false" data-item-taxable="true" data-item-taxes="CH" data-item-has-taxes-included="true" data-item-shippable="true"><span uk-icon="icon: cart" class="uk-icon"></span> Add to cart</button>

but no quantity stepper markup anywhere.

You need to activate the field "Product is stackable" otherwise there will be added a separate item each time you click the "Add to cart" button.

Share this post


Link to post
Share on other sites

I don't know your setup for the frontend templates and what you changed in the samples, but if you use the plain "Regular" site profile from PW installation it should work like in the screenshots.

I decided to use the "Regular" profile for the samples because it has easy understandable templates and the most modern output strategy. Also with its replaceable markup regions, it was very easy to implement a shop interface without changing too much.

SnipWire is built with the ProcessWire philosophy: To be as flexible as possible and to absolutely let the site developer decide what will be outputted in the front-end.

  • Like 1

Share this post


Link to post
Share on other sites

UPDATE 2020-02-08

SnipWire 0.8.2 (beta) released!

Its now possible to change the cart and catalogue currency by GET, POST or SESSION param via form submit or by adding an URL param or setting a session variable!

  • Like 1

Share this post


Link to post
Share on other sites

@Gadgetto OK, since I don't really need any kind of shop solution, I decided to uninstall SnipWire. That was... an unpleasant experience. This took me about half an hour. The regular module uninstall routine didn't work for anything SnipWire-related. There were warning about pages or fields or templates having the system-flag. The page under admin > setup was undeleteable. In the end I had to delete two pages that were in the trash directly in the database. I hope there is nothing else left in the PW installation now in some hidden corners...

Share this post


Link to post
Share on other sites

Thank you @dragan, very constructive critic! Sorry you didn't like SnipWire...

28 minutes ago, dragan said:

There were warning about pages or fields or templates having the system-flag.

There is a single page under admin > setup which has the system flag (I decided to use the system flag because if this page is deleted SnipWire won't work). I just have not yet implemented the uninstall routine for this special page in the beta. #todo

If you have a look at the docs: https://docs.bitego.com/snipwire/getting-started/install-uninstall/ the following is stated:

Quote

In addition to the 4 module packages it is highly recommended to also install the Snipcart products package!
The products package contains product templates, files, fields and some demo pages required to build a Snipcart product catalogue. This additional step is needed to prevent unintended deletion of your Snipcart products catalogue when the main module is uninstalled. These resources need to be removed manually if you like to completely uninstall SnipWire!

All other SnipWire components are uninstalled perfectly here (just tested)!

  • Like 3

Share this post


Link to post
Share on other sites
23 minutes ago, Gadgetto said:

very constructive critic!

Sorry, I know it's beta, I read (and can only imagine) how much work was involved. And as I stated before, it really is a nice touch to have that luxury of installing a few test pages instead of having to create them manually from scratch - just with a few clicks. And I was seriously impressed by the feature-set, the dashboard etc. However, uninstalling a PW module (no matter how big, if free or commercial) shouldn't be something that takes more than 2-3 minutes. I'm probably spoiled, but I just thought I'd mention it here anyway.

Share this post


Link to post
Share on other sites
38 minutes ago, dragan said:

Sorry, I know it's beta, I read (and can only imagine) how much work was involved. And as I stated before, it really is a nice touch to have that luxury of installing a few test pages instead of having to create them manually from scratch - just with a few clicks. And I was seriously impressed by the feature-set, the dashboard etc. However, uninstalling a PW module (no matter how big, if free or commercial) shouldn't be something that takes more than 2-3 minutes. I'm probably spoiled, but I just thought I'd mention it here anyway.

No problem, 🙃 I know the uninstaller needs some work to be perfect. Uninstalling a shop system and such a huge plugin is nothing trivial. Page<->field<->template dependencies needs to be resolved and you need to be very careful to prevent unintended deletion of your whole products catalogue and templates.

I'm just thinking about a "fire-and-forget" uninstaller which can only be called via URL param...

  • Like 2

Share this post


Link to post
Share on other sites

I haven't tried snipwire yet, but regarding the uninstall I have two suggestions/ideas:

1) Maybe SnipWire could state clearly before installation, that it is not trivial to uninstall this module and it might be the best option to restore a backup in case you want to get rid of snipwire. That would of course be not possible on a live system when some data has changed. In that case it might be the easiest solution to provide step by step instructions to uninstall everything manually.

2) Maybe https://github.com/BernhardBaumrock/RockMigrations have some helpful code snippets that you can use for the uninstall routine?

2RlhR6S.png

RockMigrations are built in a way that they do NOT ask for any confirmations. That means if you delete a template all related pages that use that template are also deleted. That can be too destructive in some situations but can be exactly what you want in others...

Thx for all your efforts @Gadgetto - as I said I haven't tried it yet, but it seems you are doing a great job!

  • Like 2

Share this post


Link to post
Share on other sites

Hey, @bernhard,

sorry for my late response! Just stumbled across your post.

Thanks for your hints! I've updated the installer page to clearly state which resources will be installed and why the extended installer is necessary and why it's a good idea to backup. I also put a lot of effort into the install/uninstall process and greatly improved the thing.

Share this post


Link to post
Share on other sites

UPDATE 2020-03-01

SnipWire 0.8.3 (beta) released!

In this new release the installation and uninstallation process has been heavily revised! The module and its submodules should now uninstall perfectly. To preserve the full products catalogue and products data, all fields with the custom field type FieldtypeSnipWireTaxSelector are now converted to FieldtypeText on uninstall. If yo want to reinstall SnipWire and reuse your previous products catalogue, you simply need to change the taxes field back to FieldtypeSnipWireTaxSelector.

Here is the complete list of changes:

  • Updated products package installer to add specific module config on install
  • The uninstallation process is now much more reliable
  • FieldtypeSnipWireTaxeSelector is now uninstalled properly (existing fields are converted to FieldtypeText)
  • Refactored ExtendedInstaller class to be more reliable
  • Extended resources installer page is now more user friendly
  • Fixed product price JSON output if a currency field is missing
  • Small fixes and code enhancements
  • Updated apexcharts.js vendor plugin to version 3.15.6
  • Like 3

Share this post


Link to post
Share on other sites
9 hours ago, bernhard said:

Could any of the Windows users please confirm that the installation shows the following error

It works fine here with PW 3.0.148 (almost a fresh installation). No errors.

image.thumb.png.8c3689f92af380fd73808bb0c3be45c3.png

  • Like 2

Share this post


Link to post
Share on other sites

UPDATE 2020-03-03

SnipWire 0.8.4 (beta) released!

This update improves compatibility for Windows based Systems (thanks @bernhard for your help!)

  • Like 1
  • Thanks 1

Share this post


Link to post
Share on other sites

Has anyone here worked with SnipCart's webhooks yet?

I can't find an example in their docs of a fully formed webhook file, nor am I quite sure how I would imitate their examples along with the PW API to call things so I don't have to manually enter every product, for example. Their webhook examples also seem to contain hardcoded info that should be drawn from the session?

I'm trying to set up both gift cards, and extra notifications for subscription events.

https://snipcart.com/blog/creating-a-gift-card-application-with-snipcart-php

https://docs.snipcart.com/v2/webhooks/subscription-events

Share this post


Link to post
Share on other sites

Hi @creativejay,

you can hook into SnipWire‘s predefined webhook methods. Please have a look into the Webhooks class starting at this lines: 

https://github.com/gadgetto/SnipWire/blob/8d38ced82bbfc5633a3d6de7cae6217fcd408c39/services/Webhooks.php#L312

For creating/importing products it would be best to write a small importer using the PW API which creates SnipWire (ProcessWire) pages.

  • Like 1

Share this post


Link to post
Share on other sites

Ah, thanks!

Now... Could I please get some help with the hook?

  • I've written the following (site/ready.php) but see nothing in the logs and no email arrives
  • I suspect I'm starting wrong in how I retrieve the SnipWire/SnipCart order data
  • SnipCart is currently in TEST mode
  • I've confirmed the SMTP settings in the WireMail SMTP module configuration
  • I'm operating on the assumption that the $event returned for this Hook contains the subscription information as shown on: https://docs.snipcart.com/v2/webhooks/subscription-events
$wire->addHookAfter('SnipWire::handleSubscriptionCreated', function($event) { 
	
    $snip_input = $event->arguments(0); 
	$event_json = json_decode($snip_input); 
    
    $mail = $wire->modules('WireMailSmtp'); // calling WireMail SMTP to send a notification since SnipCart doesn't
    $clientEmail = $snip_input->getChildByName('user')->email->value; // Fetching customer's email
    $clientName = $snip_input->getChildByName('user')->fullName->value; // Fetching customer's Full Name
    $products = $snip_input->getChildByName('items'); // Fetching an array of the items in the cart
    
    foreach($products as $p) {
		// For each product in the cart, we send the corresponding coach an email
        $coach = $p->getChildByName('Coach')->value;  // The coach selected at checkout
   		$kvcoach = $wire->pages->get("title=$coach"); // Coach will have a matching page on the site
    	$coachEmail = $kvcoach->email; // get email from that page's fields

		$to = array('user@domain.com'); // including the admin (me) in the TO for testing
		array_push($to,$coachEmail); // add coach's email to array
             
	    $cart = $p->getChildByName('name'); // product name from this order item

		try { 
	        $body = $coach . ", you have a new client! " . $clientName . " (". $clientEmail.") has subscribed to: " . $cart . "<br /><br />" . "<pre>" . var_export($event_json, true) . "</pre>";
	        $subject = $clientName . " (". $clientEmail.") has signed up for ". $cart;
	        $mail->to($to);
	        $mail->from('no-reply@domain.com');
	        $mail->subject($subject);
	        $mail->bodyHTML($body);
	        $mail->send();
		}
		catch (\Exception $e) {
	     $error = "Email not sent: " . $e->getMessage();
	     $mail->log($error);   
		} 
    } 
});

 

Share this post


Link to post
Share on other sites

@creativejay I must admit, now I've gotten myself into a bit of a mess. Unfortunately, most of the hookable methods are not yet ready. I am currently working on the final implementation. Sorry, you'll have to be patient. i’ll let you know when it is ready.

  • Like 3

Share this post


Link to post
Share on other sites

Just heard from SnipCart support that subscription events only fire in live mode. 
 

I’ll change the hook to order completed for testing. 

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By MoritzLost
      TrelloWire
      This is a module that allows you to automatically create Trello cards for ProcessWire pages and update them when the pages are updated. This allows you to setup connected workflows. Card properties and change handling behaviour can be customized through the extensive module configuration. Every action the module performs is hookable, so you can modify when and how cards are created as much as you need to. The module also contains an API-component that makes it easy to make requests to the Trello API and build your own connected ProcessWire-Trello workflows.
      Features
      All the things the module can do for you without any custom code: Create a new card on Trello whenever a page is added or published (you can select applicable templates). Configure the target board, target list, name and description for new cards. Add default labels and checklists to the card. Update the card whenever the page is updated (optional). When the status of the card changes (published / unpublished, hidden / unhidden, trashed / restored or deleted), move the card to a different list or archive or delete it (configurable). You can extend this through hooks in many ways: Modifiy when and how cards are created. Modify the card properties (Target board & list, title, description, et c.) before they are sent to Trello. Create your own workflows by utilizing an API helper class with many convenient utility methods to access the Trello API directly. Feedback & Future Plans
      Let me know what you think! In particular:
      If you find any bugs report them here or on Github, I'll try to fix them. This module was born out of a use-case for a client project where we manage new form submissions through Trello. I'm not sure how many use-cases there are for this module. If you do use it, tell me about it! The Trello API is pretty extensive, I'll try to add some more helper methods to the TrelloWireApi class (let me know if you need anything in particular). I'll think about how the module can support different workflows that include Twig – talk to me if you have a use-case! Next steps could be a dashboard to manage pages that are connected to a Trello card, or a new section in the settings tab to manage the Trello connection. But it depends on whether there is any interest in this 🙂 Links
      Repository on Github Complete module documentation (getting started, configuration & API documentation) TrelloWire in the modules directory Module configuration

    • By bernhard
      #######################
      Please use the new RockFinder2
      #######################
      WHY?
      This module was built to fill the gap between simple $pages->find() operations and complex SQL queries.
      The problem with $pages->find() is that it loads all pages into memory and that can be a problem when querying multiple thousands of pages. Even $pages->findMany() loads all pages into memory and therefore is a lot slower than regular SQL.
      The problem with SQL on the other hand is, that the queries are quite complex to build. All fields are separate tables, some repeatable fields use multiple rows for their content that belong to only one single page, you always need to check for the page status (which is not necessary on regular find() operations and therefore nobody is used to that).
      In short: It is far too much work to efficiently and easily get an array of data based on PW pages and fields and I need that a lot for my RockGrid module to build all kinds of tabular data.

      Basic Usage

       
      Docs & Download
      https://modules.processwire.com/modules/rock-finder/
      https://github.com/BernhardBaumrock/RockFinder
       
      Changelog
      180817, v1.0.6, support for joining multiple finders 180810, v1.0.5, basic support for options fields 180528, v1.0.4, add custom select statement option 180516, change sql query method, bump version to 1.0.0 180515, multilang bugfix 180513, beta release <180513, preview/discussion took place here: https://processwire.com/talk/topic/18983-rocksqlfinder-highly-efficient-and-flexible-sql-finder-module/
    • By MoritzLost
      Process Cache Control
      This module provides a simple solution to clearing all your cache layers at once, and an extensible interface to perform various cache-related actions.
      The simple motivation behind this module was that I was tired of manually clearing caches in several places after deploying a change on a live site. The basic purpose of this module is a simple Clear all caches link in the Setup menu which clears out all caches, no matter where they hide. You can customize what exactly the module does through it's configuration menu:
      Expire or delete all cache entries in the database, or selectively clear caches by namespace ($cache API) Clear the the template render cache. Clear out specific folders inside your site's cache directory (/site/assets/cache) Clear the ProCache page render cache (if your site is using ProCache) Refresh version strings for static assets to bust client-side browser caches (this requires some setup, see the full documentation for details). This is the basic function of the module. However, you can also add different cache management action through the API and execute them through the module's interface. For this advanced usage, the module provides:
      An interface to see all available cache actions and execute them. A system log and logging output on the module page to see verify what the module is doing. A CacheControlTools class with utility functions to clear out different caches. An API to add cache actions, execute them programmatically and even modify the default action. Permission management, allowing you granular control over which user roles can execute which actions. The complete documentation can be found in the module's README.
      Plans for improvements
      If there is some interest in this, I plan to expand this to a more general cache management solution. I particular, I would like to add additional cache actions. Some ideas that came to mind:
      Warming up the template render cache for publicly accessible pages. Removing all active user sessions. Let me know if you have more suggestions!
      Links
      https://github.com/MoritzLost/ProcessCacheControl ProcessCacheControl in the Module directory CHANGELOG in the repository Screenshots


    • By Macrura
      PrevNextTabs Module
      Github: https://github.com/outflux3/PrevNextTabs
      Processwire helper modules for adding page navigation within the editor.
      Overview
      This is a very simple module that adds Previous and Next links inline with the tabs on the page editor. Hovering over the tab shows the title of the previous or next page (using the admin's built in jqueryUI tooltips.)
      Usage
      This module is typically used during development where you or your editors need to traverse through pages for the purpose of proofing, flagging and/or commenting. Rather than returning to the page tree or lister, they can navigate with these links.
      Warnings
      If you are using PW version 2.6.1 or later, the system will prevent you from leaving the page if you have unsaved edits.
      For earlier versions, to avoid accidentally losing changes made to a page that might occur if a user accidentally clicks on one of these, make sure to have the Form Save Reminder module installed.
      http://modules.processwire.com/modules/prev-next-tabs/
×
×
  • Create New...