त्रुटि प्रतिक्रियाएँ#

HTTP स्थिति	अर्थ	अनुशंसित कार्रवाई
`400 Bad Request`	अनुरोध बॉडी या क्वेरी पैरामीटर अमान्य हैं।	पुनः प्रयास करने से पहले अनुरोध को सही करें।
`401 Unauthorized`	प्रमाणीकरण क्रेडेंशियल्स गायब, अमान्य, समाप्त, या सक्रिय नहीं हैं।	प्रमाणीकरण हेडर की जाँच करें या Ideal House से संपर्क करें।
`403 Forbidden`	अनुरोधित `shopId` क्रेडेंशियल्स से संबद्ध नहीं है।	क्रेडेंशियल्स को सौंपा गया Shop ID का उपयोग करें।
`404 Not Found`	कोई आयात स्थिति या मेल खाता प्रोडक्ट उपलब्ध नहीं है।	Shop ID और अनुरोधित प्रोडक्ट आईडी या SKU की पुष्टि करें।
`409 Conflict`	दुकान के लिए एक अन्य इम्पोर्ट जॉब सक्रिय है।	वर्तमान इम्पोर्ट जॉब समाप्त होने का प्रतीक्षा करें।
`429 Too Many Requests`	अनुरोध दर बहुत अधिक है।	घातांकीय बैकऑफ और ज़िटर के साथ पुनः प्रयास करें।
`500 Internal Server Error`	सेवा को एक अप्रत्याशित त्रुटि का सामना करना पड़ा।	घातांकीय बैकऑफ के साथ पुनः प्रयास करें। यदि त्रुटि बना रहती है तो Ideal House से संपर्क करें।
`502 Bad Gateway` या `503 Service Unavailable`	API अस्थायी रूप से अनुपलब्ध है।	घातांकीय बैकऑफ के साथ पुनः प्रयास करें।

एक सत्यापन त्रुटि निम्नलिखित प्रारूप का उपयोग कर सकती है:

json

{
  "message": ["shopId should not be empty"],
  "error": "Bad Request",
  "statusCode": 400
}

message में पाठ भिन्न हो सकता है। प्रोग्राम लॉजिक के लिए HTTP स्थिति कोड और दस्तावेज़ीकृत प्रतिक्रिया फ़ील्ड का उपयोग करें।

पुनः प्रयास और पुनर्प्राप्ति मार्गदर्शन#

जब तक कोई जॉब pending या running है, तब तक हर 2 से 5 सेकंड में पोल करें।
429, 500, 502, और 503 प्रतिक्रियाओं के लिए, ज़िटर के साथ घातांकीय बैकऑफ का उपयोग करें और अधिकतम पुनः प्रयास सीमा सेट करें।
अनुरोध या क्रेडेंशियल्स को सही करने के बिना 400, 401, या 403 प्रतिक्रियाओं का स्वतः पुनः प्रयास न करें।
409 के बाद, सक्रिय जॉब के completed या failed तक पहुँचने का प्रतीक्षा करें।
यदि प्रतिक्रिया प्राप्त होने से पहले प्रस्तुतीकरण टाइमआउट हो जाता है, तो बैच को फिर से प्रस्तुत करने से पहले स्थिति एंडपॉइंट का पूछताछ करें।
वही प्रोडक्ट वही SKU के साथ दोबारा प्रयास करना सुरक्षित है क्योंकि इम्पोर्ट्स क्रिएट-ऑर-अपडेट व्यवहार का उपयोग करते हैं।
आइटम-स्तर की विफलताओं के साथ एक पूर्ण जॉब के बाद, केवल विफल उत्पादों को शामिल करने वाला एक नया बैच प्रस्तुत करें।
जॉब-स्तर की विफलता के बाद, successCount में गिने गए उत्पाद पहले से ही अपडेट हो चुके हो सकते हैं। वही SKU के साथ मूल बैच को फिर से प्रस्तुत करना सुरक्षित है।
हटाना पहले से ही प्रभावी हो चुका हो सकता है, भले ही अनुरोध 503 लौटाता है। वही हटाने अनुरोध का पुनः प्रयास करना सुरक्षित है।

स्थिति एंडपॉइंट सक्रिय या सबसे हाल की जॉब को ट्रैक करने के लिए है, स्थायी इम्पोर्ट इतिहास के लिए नहीं। संशोधन और सहायता के लिए प्रस्तुत किए गए बैच, jobId, स्थिति प्रतिक्रियाओं और अंतिम परिणाम को अपने स्वयं के सिस्टम में संग्रहीत करें।

प्रोडक्शन चेकलिस्ट#

Client Secret को एक सीक्रेट्स मैनेजर या सुरक्षित सर्वर पर्यावरण में संग्रहीत करें।
हर उत्पाद के लिए एक स्थिर, अद्वितीय SKU का उपयोग करें।
प्रति अनुरोध 500 से अधिक उत्पाद न भेजें।
सुनिश्चित करें कि इमेज URLs सार्वजनिक रूप से पहुँच योग्य हैं और प्रोसेसिंग के दौरान उपलब्ध रहते हैं।
केवल तभी processImages: true को स्पष्ट रूप से सेट करें जब इमेज प्री-प्रोसेसिंग की आवश्यकता हो और संबंधित 1-क्रेडिट-प्रति-इमेज प्रोसेसिंग शुल्क स्वीकार किया गया हो। अन्यथा इसे छोड़ दें या इसे false सेट करें।
फ़्लोर स्प्लिटिंग को केवल तभी सक्षम करें जब processImages और processFloorImages दोनों को true सेट किया जाए।
हर उत्पाद के लिए name, imageUrl, productUrl, width, height, और एक समर्थित productType प्रदान करें।
जब प्रदान किया जाए, तो status को active, inactive, out_of_stock, या invalid सेट करें।
आकारों को समर्थित इकाई के साथ धनात्मक मानों के रूप में भेजें, या इंच का उपयोग करने के लिए इकाई को छोड़ दें; संग्रहीत मानों को इंच में सामान्यीकृत किया जाता है।
लौटाए गए jobId को स्थायी रूप से संग्रहीत करें और इसे बाद की स्थिति प्रतिक्रियाओं के साथ तुलना करें।
completed को failedCount > 0 के साथ आंशिक सफलता के रूप में मानें।
असीमित कैटलॉग के अनुरोध करने के बजाय उत्पाद सूची के माध्यम से पेजिनेशन करें।
हटाने संक्रियाओं के लिए productId या sku में से ठीक एक प्रदान करें।
घातांकीय बैकऑफ और ज़िटर के साथ सीमित पुनः प्रयास लागू करें।

क्रेडेंशियल्स, ऑनबोर्डिंग मान, उत्पाद-प्रकार मैपिंग, या स्थायी एकीकरण समस्याओं के लिए, अपने Ideal House एकीकरण प्रतिनिधि से संपर्क करें।