Ideal House
सामग्री पर जाएं

Ideal House Product Import API#

Product Import API का उपयोग करके अपने Ideal House कैटलॉग में उत्पादों को आयात, सूचीबद्ध और तार्किक रूप से हटाने के लिए उपयोग करें। बैच आयात 1 से 500 उत्पादों को स्वीकार करते हैं और असिंक्रोनस रूप से प्रोसेस किए जाते हैं। सूचीबद्ध करने और हटाने की प्रक्रियाएँ सिंक्रोनस रूप से प्रोसेस की जाती हैं।

बेस URL#

text
https://sdkapi.ideal.house

सभी अनुरोधों के लिए HTTPS का उपयोग करें। JSON अनुरोध और प्रतिक्रिया शरीर UTF-8 के रूप में एन्कोड किए जाते हैं।

शुरू करने से पहले#

ऑनबोर्डिंग के दौरान Ideal House निम्नलिखित मान प्रदान करेगा:

  • एक Shop ID
  • एक Client ID
  • एक Client Secret

Client ID और Client Secret सर्वर-साइड क्रेडेंशियल हैं। कभी भी Client Secret को ब्राउज़र कोड, मोबाइल एप्लिकेशन, सार्वजनिक रिपॉज़िटरी, लॉग या अन्य क्लाइंट-साइड वातावरण में प्रकट न करें।

प्रमाणीकरण#

प्रत्येक अनुरोध में इन हेडरों को शामिल करें:

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

जिन अनुरोधों में JSON शरीर होता है, उनमें भी शामिल करें:

http
Content-Type: application/json

अनुरोध में shopId क्रेडेंशियल से जुड़े शॉप से मेल खाना चाहिए। मेल न खाने पर 403 Forbidden लौटता है।

API सारांश#

विधिपथउद्देश्य
POST/product-import/productsअसिंक्रोनस उत्पाद आयात बैच सबमिट करें।
GET/product-import/products/statusवर्तमान या सबसे हालिया आयात जॉब प्राप्त करें।
GET/product-import/productsशॉप के वर्तमान उत्पादों की सूची बनाएं।
DELETE/product-import/productsउत्पाद आईडी या SKU द्वारा एक उत्पाद को तार्किक रूप से हटाएं।

बैच आयात प्रवाह#

  1. POST /product-import/products के साथ उत्पाद बैच सबमिट करें।
  2. 202 Accepted प्रतिक्रिया में लौटे jobId को सहेजें।
  3. हर 2 से 5 सेकंड में GET /product-import/products/status का पोलिंग करें।
  4. जब स्थिति completed या failed हो जाए, तो पोलिंग बंद करें।
  5. यदि जॉब completed है, तो आइटम-स्तर की त्रुटियों के लिए failedCount और failures की जांच करें।

एक समय पर एक शॉप के लिए केवल एक आयात जॉब सक्रिय हो सकती है।