Sherweb icon

Sherweb

Interact with Sherweb API

Overview

This node interacts with the Sherweb API to retrieve customer catalog information. Specifically, the "Get Customer Catalogs" operation fetches catalogs associated with a given customer ID. This is useful for scenarios where you need to programmatically access or synchronize product/service catalogs assigned to customers in Sherweb's system.

Practical examples include:

  • Automating the retrieval of available product catalogs for a specific customer to display or process them in another system.
  • Integrating Sherweb customer catalog data into a CRM or ERP platform.
  • Periodically syncing catalog data for reporting or auditing purposes.

Properties

Name Meaning
API Type Selects which Sherweb API to use: either "Service Provider API" or "Distributor API".
Customer ID The unique identifier of the customer whose catalogs you want to retrieve (required).

Output

The node outputs JSON data representing the customer catalogs retrieved from Sherweb. The structure typically includes details about each catalog linked to the specified customer, such as catalog IDs, names, descriptions, and possibly other metadata depending on the API response.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API authentication token configured via OAuth2 credentials for Sherweb.
  • Needs a subscription key provided in the node credentials to authorize API requests.
  • The base URL for API calls is https://api.sherweb.com.

Troubleshooting

  • Missing or invalid Customer ID: Ensure the Customer ID property is correctly set; otherwise, the API call will fail.
  • Authentication errors: Verify that the OAuth2 credentials and subscription key are valid and have not expired.
  • API type mismatch: Selecting the wrong API type (Service Provider vs Distributor) may result in no data or errors; confirm the correct API type for your use case.
  • Network issues: Check connectivity to api.sherweb.com and firewall settings if requests time out.

Common error messages might include unauthorized access, resource not found, or bad request due to missing parameters. Resolving these usually involves verifying credentials, input parameters, and API permissions.

Links and References

  • Sherweb API Documentation (for detailed API endpoints and data structures)
  • n8n OAuth2 Credential Setup Guide (for configuring API authentication)

Discussion