Sharpei icon

Sharpei

Consume Sharpei Api

Overview

This node integrates with the Sharpei API to retrieve product information based on a remote product ID. Specifically, the "Get Product by Remote ID" operation fetches detailed data about a single product identified by its unique remote ID in the Sharpei system.

This node is useful when you need to synchronize or display product details from Sharpei within your workflows, such as updating inventory, displaying product info on a website, or processing orders that require product validation.

Example use cases:

  • Fetching product details before creating an order.
  • Synchronizing product data between Sharpei and another system.
  • Displaying product information dynamically in a customer-facing application.

Properties

Name Meaning
Remote ID The unique identifier of the product in the Sharpei system for which details are fetched

Output

The node outputs JSON data representing the product details retrieved from the Sharpei API. This typically includes all relevant product fields such as name, description, price, availability, and other metadata as provided by the API.

If the product has associated binary data (e.g., images), the node may also output this in a binary format, but this is not explicitly shown in the provided code.

Dependencies

  • Requires an active connection to the Sharpei API.
  • Needs an API authentication token or key configured in the node credentials to authorize requests.
  • The base URL for API requests is https://api.prod.gosharpei.com/api.
  • The node expects JSON responses and sends JSON requests.

Troubleshooting

  • Missing or invalid Remote ID: Ensure the Remote ID property is correctly set and corresponds to an existing product in Sharpei.
  • Authentication errors: Verify that the API key or authentication token is valid and has sufficient permissions.
  • Network issues: Check connectivity to the Sharpei API endpoint.
  • Unexpected API response: Confirm that the API version and endpoint have not changed; update the node if necessary.

Common error messages might include:

  • Unauthorized access due to invalid credentials.
  • Not found errors if the Remote ID does not exist.
  • Timeout or network errors if the API is unreachable.

Resolving these usually involves verifying credentials, input values, and network status.

Links and References

Discussion