Polar icon

Polar

Consume Polar.sh API
Join our community

Actions13

Overview

This node integrates with the Polar.sh API to manage products, customers, and checkout sessions. Specifically for the Product - Archive operation, it allows users to archive a product by its ID. Archiving a product typically means marking it as inactive or removing it from active listings without deleting it permanently.

Common scenarios where this node is beneficial include:

  • E-commerce platforms needing to retire products that are no longer available.
  • Subscription services managing product lifecycle without losing historical data.
  • Inventory systems that want to keep archived products for reporting but exclude them from sales.

Example use case: Automatically archive a product when it is discontinued or out of stock, ensuring it no longer appears in customer-facing catalogs.

Properties

Name Meaning
Product ID The unique identifier of the product to archive

Output

The node outputs the JSON response returned by the Polar.sh API after attempting to archive the product. This typically includes confirmation of the archive action or details about the archived product.

If multiple items were processed (in batch mode), the output will be an array of JSON objects corresponding to each product's archive result.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Polar.sh API.
  • The node uses the Polar.sh base URL, which switches between sandbox and production environments based on credential configuration.
  • No additional external dependencies beyond the Polar.sh API.

Troubleshooting

  • Common issues:

    • Invalid or missing Product ID: Ensure the Product ID provided exists and is correctly formatted.
    • Authentication errors: Verify that the API key credential is valid and has necessary permissions.
    • Network or API downtime: Check connectivity and Polar.sh service status.

  • Error messages:

    • Errors returned from the API will be included in the output under an error field if "Continue On Fail" is enabled.
    • Typical error messages might indicate invalid IDs, permission denied, or rate limiting.

  • Resolution tips:

    • Double-check input parameters.
    • Confirm API credentials and environment settings.
    • Use "Continue On Fail" cautiously to handle partial failures gracefully.

Links and References

Discussion