Sperse icon

Sperse

Sperse CRM enables secure payment processing and affiliate marketing for online businesses
Join our community

Actions6

Overview

This node integrates with Sperse CRM to create a new product entry in the system. It is designed for online businesses that want to manage their products, including digital goods, donations, events, subscriptions, and general merchandise, within Sperse's secure payment processing and affiliate marketing platform.

Typical use cases include:

  • Adding new products to an e-commerce or subscription platform.
  • Managing different types of products with various pricing models (one-time or subscription).
  • Defining detailed product attributes such as descriptions, logos, pricing cycles, and trial periods.

For example, a business selling digital courses can use this node to create a "Digital" product type with subscription pricing and trial days, while a charity organization might create a "Donation" product type with one-time pricing.

Properties

Name Meaning
Product Type The category of the product on Sperse side. Options: Digital, Donation, Event, General, Subscription.
Product Name The name/title of the product.
SKU The stock keeping unit or product code identifier.
Description A plain text description of the product.
Description HTML An HTML-formatted description of the product. Note: JavaScript and media tags are not allowed.
Logo Url URL pointing to the product's logo image.
Group Name Optional grouping name for categorizing the product.
Currency ID The currency used for the product price. Options include AUD, CAD, CHF, CNY, EUR, GBP, IND, JPY, NZD, SEK, USD.
Unit The unit of measurement for the product. Required for General and Digital product types. Options include Custom, Day, Feet, Hour, Kilogram, Month, Package, Piece, Pound, Unit, Year, Zone.
Price Type Pricing model for the product. Options: OneTime, Subscription.
Payment Cycle Frequency of payment cycle. Required for General and Digital product types. Options: Annual, Custom, LifeTime, Monthly, OneTime.
Subscription Fee The recurring fee amount for subscription products.
No of Cycles Number of billing cycles. Required for all except LifeTime or OneTime plans.
Signup Fee Initial signup fee charged. Required for all except LifeTime or OneTime plans.
Custom Period Type Time unit for custom or one-time plans. Options: Days, Months, Weeks, Years.
Custom No of Period Number of custom periods. Required for custom or one-time plans.
Trial Day Count Number of trial days offered. Required for OneTime plan.
Grace Period Count Number of grace period days after subscription expiration.

Output

The node outputs a JSON object representing the created product as returned by the Sperse API. This typically includes all the product details sent during creation along with any additional metadata or identifiers assigned by the system.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to Sperse CRM via an API key credential configured in n8n.
  • The node uses the Sperse API endpoint /api/services/CRM/Import/ImportProduct to create the product.
  • Proper permissions and API access must be granted to the API key used.

Troubleshooting

  • Missing required fields: Ensure all mandatory properties like Product Type, Product Name, SKU, Currency ID, and Price Type are provided. Missing these will cause API errors.
  • Invalid HTML in Description HTML: Avoid using JavaScript or media tags in the HTML description field to prevent rejection.
  • Incorrect combinations: For example, Unit and Payment Cycle are required only for certain product types; providing inconsistent values may cause errors.
  • API authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Network issues: Check connectivity to the Sperse API endpoint if requests time out or fail.

If the node throws errors related to invalid parameters or failed API calls, review the input data carefully and consult Sperse API documentation for constraints.

Links and References

Discussion