commerce

GET /v1/orders/{orderId}

Get an order.

सभी commerce एंडपॉइंट्स

प्रमाणन

एक बीयर टोकन के रूप में एक API कुंजी भेजें। यह एंडपॉइंट विनिर्देश में किसी विशिष्ट अनुमति का उल्लेख नहीं करता है, इसलिए अपनी कुंजी को न्यूनतम आवश्यकता दें और अनुमान लगाने के बजाय प्रतिक्रिया की जाँच करें।

यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

curl -X GET https://api.zinndigital.com/v1/orders/{orderId} \
  -H "Authorization: Bearer zdk_live_…"

साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें

विवरण

Returns one order with its lines and payment summaries. RBAC + RLS scoped.

पैरामीटर

नामप्रकारआवश्यकयह क्या है
orderId (path)UuidहाँThe order's id.

प्रतिक्रिया

नामप्रकारआवश्यकयह क्या है
idUuidहाँUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidहाँUUIDv7 identifier — sortable by creation time (docs/02 §8).
human_refstringहाँHuman-friendly order reference.
statusOrderStatusहाँAn order's lifecycle state (docs/31 §4.3).
currencyCurrencyCodeहाँISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
subtotal_minorintegerहाँ
tax_minorintegerहाँ
discount_minorintegerहाँ
total_minorintegerहाँ
billing_countryobjectनहीं
placed_atobjectनहीं
created_atstringहाँ
updated_atstringनहीं
linesOrderLine[]हाँ
paymentsPayment[]हाँ

त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है

401 · 403 · 404 · 429