The Product Search Endpoint allows Apliiq to retrieve product information from your third-party ecommerce platform.

By adding a product search URL to your Apliiq account, you allow Apliiq to send a GET request to your system and return products from your ecommerce store. This is useful when Apliiq needs to identify, match, update, or import product information from your store.

How It Works

The Product Search Endpoint is a custom GET URL that is saved inside your Apliiq account.

When Apliiq needs to search for products in your ecommerce platform, Apliiq will send a GET request to the product search URL you have provided. Your system should return matching product data from your store in a format Apliiq can use.

This endpoint may be used in several Apliiq workflows where a product must be identified inside your third-party ecommerce platform.

For example, Apliiq may use the Product Search Endpoint to:

• Find an existing product in your store.
• Update an existing product connected to Apliiq.
• Download product information from your store for warehousing.
• Match store products to Apliiq products.
• Confirm that a product exists in your ecommerce platform.

Where to Add Your Product Search URL

You can add your Product Search Endpoint URL in the same location as your other store webhooks.

1. Log in to your Apliiq account.
2. Go to your Stores page.
3. Locate the webhook settings for your store.
4. Add your product search GET URL.
5. Save your changes.

Once your product search URL has been saved, Apliiq can use it when a workflow requires product information from your ecommerce platform.

What Your Endpoint Should Do

Your Product Search Endpoint should accept a GET request from Apliiq and return product records from your ecommerce platform.

Your system should be able to:

• Receive the GET request from Apliiq.
• Search your ecommerce platform for matching products.
• Return product information in the expected response format.
• Include enough product data for Apliiq to identify the correct product.
• Return a successful response when the request is processed.
• Return an appropriate error response if the request cannot be completed.

When the Product Search Endpoint Is Used

The Product Search Endpoint is used when Apliiq needs to locate or retrieve product information from your third-party ecommerce platform.

Common use cases include:

Updating an Existing Product

If you want to update an existing product in your store, Apliiq may first need to search your ecommerce platform to identify the correct product. The Product Search Endpoint allows Apliiq to retrieve matching products so the correct item can be selected or updated.

Downloading Product Information for Warehousing

Apliiq may use this endpoint to download product details from your ecommerce platform for warehousing-related workflows. This helps Apliiq identify the products, variants, SKUs, and other store data needed to support fulfillment or inventory processes.

Matching Store Products to Apliiq Products

The Product Search Endpoint can help connect products in your ecommerce platform with products in Apliiq. This is helpful when products already exist in your store and need to be linked to Apliiq workflows.

What Data Should Be Returned?

Your Product Search Endpoint should return product information from your ecommerce platform.

The returned product data may include:

• Product title
• Product ID from your ecommerce platform
• Product handle or URL
• Product description
• Product images
• Variant information
• Size and color options
• SKU or product identifiers
• Pricing information
• Inventory or availability information
• Additional product metadata

The exact response requirements may depend on your integration and the Apliiq workflow using the endpoint.

Endpoint Requirements

Your product search URL must be able to accept a GET request from Apliiq.

Your endpoint should be:

• Publicly accessible by Apliiq.
• Able to return product data from your ecommerce platform.
• Configured to respond quickly and reliably.
• Capable of returning clear error messages when needed.
• Protected against unauthorized or invalid requests, when applicable.

Important Notes

The Product Search Endpoint does not create products in your store. It is used to retrieve product information from your ecommerce platform so Apliiq can support workflows that require product lookup, matching, importing, or updating.

Your receiving system is responsible for searching your ecommerce platform and returning the correct product data to Apliiq.

If your product search URL is incorrect, unavailable, or does not return the expected data, Apliiq may not be able to find or use products from your store successfully.

Troubleshooting

If Apliiq cannot find products from your ecommerce platform, check the following:

• Confirm your product search URL is correct.
• Make sure your endpoint accepts GET requests.
• Verify that your endpoint is publicly accessible.
• Confirm your endpoint is returning product data in the expected format.
• Check whether the product exists in your ecommerce platform.
• Review your server logs to confirm whether the request was received.
• Make sure your endpoint returns a successful response when products are found.
• Confirm your endpoint returns helpful errors when no products are found or when a request fails.

Summary

The Product Search Endpoint allows Apliiq to retrieve product information from your third-party ecommerce platform using a custom GET URL.

Once your product search URL is added under your store webhook settings, Apliiq can use it in workflows that require product lookup, product matching, product updates, or downloading product information from your store for warehousing.