Ideal House
Skip to content

Ideal House Product Import API#

Use the Product Import API to import, list, and logically delete products in your Ideal House catalog. Batch imports accept 1 to 500 products and are processed asynchronously. Listing and deletion operations are processed synchronously.

Base URL#

text
https://sdkapi.ideal.house

Use HTTPS for all requests. JSON request and response bodies are encoded as UTF-8.

Before You Begin#

Ideal House will provide the following values during onboarding:

  • A Shop ID
  • A Client ID
  • A Client Secret

The Client ID and Client Secret are server-side credentials. Never expose the Client Secret in browser code, mobile applications, public repositories, logs, or other client-side environments.

Authentication#

Include these headers with every request:

http
X-Client-Id: <YOUR_CLIENT_ID>
X-Client-Secret: <YOUR_CLIENT_SECRET>

For requests with a JSON body, also include:

http
Content-Type: application/json

The shopId in the request must match the shop associated with the credentials. A mismatch returns 403 Forbidden.

API Summary#

MethodPathPurpose
POST/product-import/productsSubmit an asynchronous product import batch.
GET/product-import/products/statusGet the current or most recent import job.
GET/product-import/productsList the shop's current products.
DELETE/product-import/productsLogically delete one product by Product ID or SKU.

Batch Import Flow#

  1. Submit a product batch with POST /product-import/products.
  2. Save the jobId returned in the 202 Accepted response.
  3. Poll GET /product-import/products/status every 2 to 5 seconds.
  4. Stop polling when the status becomes completed or failed.
  5. If the job is completed, inspect failedCount and failures for item-level errors.

Only one import job can be active for a shop at a time.