गड़बड़ी के कोड

इस पेज पर, कैननिकल गड़बड़ी कोड के बारे में बताया गया है. Universal Commerce Protocol (यूनिवर्सल कॉमर्स प्रोटोकॉल) का इस्तेमाल करके, Google के साथ इंटिग्रेट करते समय, आपको अपनी एपीआई प्रतिक्रियाओं में ये कोड देने होंगे. गड़बड़ी के कोड एक जैसे होने से, साफ़ तौर पर जानकारी मिलती है. साथ ही, Google को अलग-अलग स्थितियों को सही तरीके से हैंडल करने में मदद मिलती है.

कारोबार से जुड़ी गड़बड़ी होने पर, आपके एपीआई को ऐसा जवाब देना चाहिए जिसमें टेबल में दिया गया सही code शामिल हो. गड़बड़ी के कुछ कोड के लिए, जवाब में messages ऐरे के लिए खास JSON स्ट्रक्चर का इस्तेमाल करने का सुझाव दिया जाता है. ये उदाहरण, टेबल के नीचे दिए गए गड़बड़ी के कोड के उदाहरण सेक्शन में दिए गए हैं. इन उदाहरणों में, आपको path फ़ील्ड का इस्तेमाल करना चाहिए. इससे अनुरोध या जवाब ऑब्जेक्ट में गड़बड़ी की जगह के बारे में ज़्यादा जानकारी दी जा सकती है.

गड़बड़ी ठीक करना

गड़बड़ियों की शिकायत करने का तरीका, गड़बड़ी के टाइप पर निर्भर करता है:

• प्रोटोकॉल/सर्वर से जुड़ी गड़बड़ियां:

  • अनुरोधों के गलत फ़ॉर्मैट में होने, पुष्टि न हो पाने या सर्वर के उपलब्ध न होने जैसी समस्याओं के लिए, स्टैंडर्ड एचटीटीपी स्टेटस कोड का इस्तेमाल करें. जैसे, क्लाइंट की गड़बड़ियों के लिए 4xx और सर्वर की गड़बड़ियों के लिए 5xx.
  • ज़्यादा जानकारी के लिए, यूसीपी स्पेसिफ़िकेशन देखें.

• कारोबार के लॉजिक से जुड़ी गड़बड़ियां/चेतावनी:

  • HTTP 200 OK स्टेटस दिखाएं. इसमें पेमेंट अस्वीकार होने और धोखाधड़ी की वजह से पेमेंट खारिज होने के मामले शामिल हैं. भले ही, डाउनस्ट्रीम पेमेंट गेटवे से 4xx या 5xx गड़बड़ी का मैसेज मिला हो.
  • JSON रिस्पॉन्स बॉडी में मौजूद messages कलेक्शन में समस्या के बारे में जानकारी दें.
  • messages कलेक्शन में मौजूद हर ऑब्जेक्ट में ये शामिल होने चाहिए:
    • type: "error" या "warning"
    • code: इस गाइड से लिया गया स्टैंडर्ड कोड. "invalid" जैसे सामान्य या पहचाने न जाने वाले कोड का इस्तेमाल न करें.
    • content: ऐसा ब्यौरा जिसे आसानी से पढ़ा जा सके.
    • severity: type की वैल्यू "error" होने पर, यह एट्रिब्यूट ज़रूरी है. इस फ़ील्ड से साफ़ तौर पर पता चलता है कि गड़बड़ी गंभीर (unrecoverable) है या इससे खरीदार को समस्या ठीक करने के लिए कहा जा सकता है (recoverable). इसके लिए, गड़बड़ी कोड पर भरोसा करने की ज़रूरत नहीं होती.

मैसेज के टाइप: गड़बड़ी बनाम चेतावनी

मैसेज ऐरे में मौजूद type फ़ील्ड से, समस्या की गंभीरता का पता चलता है. यूसीपी, मुख्य तौर पर दो तरह के होते हैं:

• error: इससे पता चलता है कि अनुरोध की गई कार्रवाई पूरी नहीं की जा सकी. ऐसा हो सकता है कि प्लैटफ़ॉर्म या उपयोगकर्ता को कार्रवाई करनी पड़े और फिर से कोशिश करनी पड़े. message-error specification देखें.
  • किसी गड़बड़ी के गंभीर होने का पता, गड़बड़ी code से नहीं, बल्कि severity फ़ील्ड (unrecoverable या recoverable) से चलता है.
• warning: इससे पता चलता है कि कार्रवाई को ब्लॉक नहीं किया गया है, लेकिन उपयोगकर्ता को कुछ ज़रूरी जानकारी देनी चाहिए. इससे प्रोसेस रुकती नहीं है, लेकिन ज़रूरी जानकारी मिलती है. message-warning specification देखें.

गड़बड़ी के कोड की जानकारी

गड़बड़ी के कोड के उदाहरण

इस सेक्शन में, खास गड़बड़ी कोड के लिए messages कलेक्शन के JSON उदाहरण दिए गए हैं.

out_of_stock

एक आइटम के लिए चेकआउट:

{
  "type": "error",
  "severity": "unrecoverable",
  "code": "out_of_stock",
  "content": "Unfortunately, the item 'Example Product 1' is out of stock."
}

एक से ज़्यादा आइटम के लिए चेकआउट:

path फ़ील्ड का इस्तेमाल करके, उस आइटम का इंडेक्स बताएं जो स्टॉक में नहीं है.

{
  "type": "error",
  "severity": "recoverable",
  "code": "out_of_stock",
  "path": "$.checkout.line_items[1]",
  "content": "The item 'Example Product 2' is out of stock. Remove it from your cart to continue."
}

quantity_invalid_limit_exceeded

{
  "type": "error",
  "severity": "recoverable",
  "code": "quantity_invalid_limit_exceeded",
  "path": "$.checkout.line_items[0].quantity",
  "content": "The requested quantity for 'Example Product 2' exceeds the maximum allowed limit of 5."
}

totals_changed

{
  "type": "warning",
  "code": "totals_changed",
  "path": "$.totals[2]",
  "content": "Shipping cost has changed."
}

missing_buyer_info

{
  "type": "error",
  "severity": "recoverable",
  "code": "missing_buyer_info",
  "path": "$.buyer.first_name",
  "content": "Missing buyer first name."
}

address_undeliverable

ऑर्डर-लेवल की पाबंदी (जैसे, पिन कोड इस्तेमाल नहीं किया जा सकता):

{
  "type": "error",
  "severity": "recoverable",
  "code": "address_undeliverable",
  "content": "Delivery is not supported for the provided zipcode."
}

सामान के लेवल पर पाबंदी:

path फ़ील्ड का इस्तेमाल करके, यह बताएं कि कोई खास आइटम, चुनी गई जगह पर डिलीवर नहीं किया जा सकता. जैसे, किसी राज्य में प्रॉडक्ट की बिक्री पर पाबंदी.

{
  "type": "error",
  "severity": "recoverable",
  "code": "address_undeliverable",
  "path": "$.checkout.line_items[1]",
  "content": "The item 'Example Product 2' cannot be delivered to the selected address."
}

address_unverifiable

बिलिंग पता:

{
  "type": "error",
  "severity": "recoverable",
  "code": "address_unverifiable",
  "path": "$.payment.instruments[0].billing_address",
  "content": "Invalid billing address. Update the address before trying again."
}

आइटम भेजने का पता:

{
  "type": "error",
  "severity": "recoverable",
  "code": "address_unverifiable",
  "path": "$.fulfillment.methods[0].destinations[0]",
  "content": "The fulfillment address couldn't be verified. Update the address and try again."
}

missing_billing_info

बिलिंग पते में मौजूद छूटे हुए फ़ील्ड की जानकारी देने के लिए, path फ़ील्ड का इस्तेमाल करें.

{
  "type": "error",
  "severity": "recoverable",
  "code": "missing_billing_info",
  "path": "$.payment.instruments[0].billing_address.street_address",
  "content": "Missing billing street address."
}

identity_required

REST API में, इस गड़बड़ी को एचटीटीपी स्टेटस कोड 401 के साथ दिखाना चाहिए.

{
  "type": "error",
  "severity": "requires_buyer_review",
  "code": "identity_required",
  "content": "User identity is required to access order history."
}

insufficient_scope

REST API में, यह गड़बड़ी एचटीटीपी स्टेटस कोड 403 के साथ दिखनी चाहिए.

{
  "type": "error",
  "severity": "requires_buyer_review",
  "code": "insufficient_scope",
  "content": "This operation requires scopes: dev.ucp.shopping.order:read, dev.ucp.shopping.order:manage"
}

पेमेंट से जुड़ी गड़बड़ियां

payment_declined

{
  "type": "error",
  "severity": "recoverable",
  "code": "payment_declined",
  "path": "$.payment.instruments[0]",
  "content": "Payment was declined by the issuer. Try a different payment method or contact your bank."
}

rejected_for_fraud

{
  "type": "error",
  "severity": "recoverable",
  "code": "rejected_for_fraud",
  "path": "$.payment.instruments[0]",
  "content": "The order was rejected due to suspected fraud. Try a different payment method."
}