Plugin hub

Shop

shop · v1.9.0 · nuxtcms >=1.6.0 · 0 installs

Turn products into a store: prices, sale prices, variants, stock, gallery, cart, checkout, coupons, delivery and pickup, multiple stores (pickup points, order assignment, stock per store), shipping templates (per piece / weight / region), VAT, Stripe / PayPal / Paytrail / WeChat Pay / Alipay / bank transfer / cash on delivery, member accounts with address book, points, two-level affiliate program, marketplace merchants (approval, product ownership, settlement and payouts), invoice requests and receipts, order admin and emails.

What it does

Scheduled tasks
Shop: cancel stale unpaid orders · */30 * * * *

Settings

Currencycurrency · select
Prices include tax (typical EU VAT)pricesIncludeTax · boolean
Default tax rate %taxRate · number

Products can override it; 0 = no tax

Offer deliverydeliveryEnabled · boolean
Delivery fee (flat)shippingFlat · number
Free delivery over (0 = never)freeShippingOver · number
Ship to countries (ISO codes, comma separated, blank = any)countries · text
Offer store pickuppickupEnabled · boolean
Pickup address and opening hourspickupAddress · textarea
Minimum order (0 = none)minOrder · number
Order number prefixorderPrefix · text
New order notification emailnotifyEmail · text
Cancel unpaid online orders after (hours, 0 = never)autoCancelHours · number
Terms page URL (checkout asks to accept it)termsUrl · text
Member accounts (sign-up, address book, order history)membersEnabled · boolean
Allow guest checkout (off = sign-in required to check out)guestCheckout · boolean
Points (needs member accounts)pointsEnabled · boolean
Points earned per currency unit spentpointsEarnRate · number

Awarded when the order is completed, on the amount paid for goods; 0 = none

Points worth one currency unitpointsValue · number
Points may pay up to % of the goodspointsMaxPercent · number
Points for signing uppointsSignup · number
Two-level affiliate program (needs member accounts)affiliateEnabled · boolean

Members get their share link under My account → Affiliate; two levels at most

Level 1 commission % (direct)affiliateRate1 · number

Of the amount paid for goods, shipping excluded

Level 2 commission % (the affiliate's inviter, 0 = one level only)affiliateRate2 · number
Affiliates need approvalaffiliateApproval · boolean
Share link lifetime (days)affiliateCookieDays · number

Orders within this time after the click count; visitors who sign up stay bound for good

Days after completion before commission is creditedaffiliateHoldDays · number

A refund in this time cancels the commission

Smallest withdrawalaffiliateMinWithdraw · number
Marketplace: merchants can join (needs member accounts)marketplaceEnabled · boolean

Members apply at the merchant centre (/merchant); once approved they manage their products' prices and stock, see their orders and earnings

Default platform commission %marketplaceCommission · number

Of the merchant's sales; can be set per merchant

Days after completion before merchants are paidmarketplaceHoldDays · number
Smallest merchant payoutmarketplaceMinPayout · number
Invoices / receiptsinvoiceMode · select
Seller name on receiptsinvoiceSellerName · text
Seller tax / VAT IDinvoiceSellerTaxId · text
Seller addressinvoiceSellerAddress · textarea
Receipt footer (optional)invoiceNote · textarea
Show floating cart buttonfloatingCart · boolean
Payment: bank transferbankTransfer · boolean
Bank transfer instructionsbankDetails · textarea
Payment: cash on delivery / at pickupcashOnDelivery · boolean
Stripe secret key (sk_…, enables Stripe)stripeSecretKey · secret
Stripe webhook signing secret (whsec_…, optional)stripeWebhookSecret · secret

Endpoint /api/shop/webhooks/stripe, event checkout.session.completed

PayPal client ID (enables PayPal)paypalClientId · text
PayPal secretpaypalSecret · secret
PayPal sandbox modepaypalSandbox · boolean
Paytrail merchant ID (Finnish banks and cards, enables Paytrail)paytrailMerchantId · text
Paytrail secret keypaytrailSecret · secret
WeChat Pay merchant ID (CNY only; the next five fields enable it)wechatMchId · text
WeChat Pay AppID (official account, mini program or open platform app)wechatAppId · text
WeChat Pay API v3 key (32 characters)wechatApiV3Key · secret
Merchant API certificate serial numberwechatSerialNo · text
Merchant API private key (contents of apiclient_key.pem)wechatPrivateKey · secret
WeChat Pay public key ID (PUB_KEY_ID_…, optional)wechatPublicKeyId · text
WeChat Pay public key (optional, verifies callback signatures)wechatPublicKey · textarea

Callback: /api/shop/webhooks/wechat (https required)

Use H5 pay in mobile browsers (enable H5 pay and its domain on the merchant platform)wechatH5 · boolean
Alipay AppID (CNY only; the next two fields enable it)alipayAppId · text
App private key (RSA2, PKCS8 or PKCS1)alipayPrivateKey · secret
Alipay public key (not the app public key)alipayPublicKey · textarea

Public-key mode; notification URL: /api/shop/webhooks/alipay

Alipay sandboxalipaySandbox · boolean

How to install

Package plugin (needs a rebuild) · Run in your site project

node node_modules/nuxtcms/scripts/plugin.mjs add shop