ऑर्डर का कोट

POST/account/api/v1/quote

प्राधिकरण

Authorization	`Bearer YOUR_ARNPROXY_API_KEY`
आवश्यक अनुमति	`read`
Accept	`application/json`
Content-Type	`application/json`

पैरामीटर

नाम	प्रकार	विवरण
`product_id` bodyआवश्यक	`integer`	products से उत्पाद ID; 1–2147483647।
`lines` bodyआवश्यक	`object[]`	एक उत्पाद के 1–20 अलग स्थान। location_id दोहराएँ नहीं; कुल अधिकतम 100000 प्रॉक्सी।
`lines[].location_id` bodyआवश्यक	`integer`	चुने उत्पाद कैटलॉग की स्थान ID।
`lines[].time_id` bodyआवश्यक	`integer`	उस स्थान पर उपलब्ध अवधि ID।
`lines[].quantity` bodyआवश्यक	`integer`	1–100000; product.minimum_quantity भी लागू।
`promo_code` bodyवैकल्पिक	`string`	वैकल्पिक प्रमोशन, अधिकतम 100 बाइट। कोट और खरीद/नवीनीकरण में समान रखें। डिफ़ॉल्ट: `""`

अनुरोध का मुख्य भाग

YOUR_/FROM_ को संबंधित कैटलॉग, कोट या दायरे के मान से बदलें। उदाहरणों में सहमति false है; वास्तविक कार्रवाई केवल जानबूझकर मंज़ूर करें।

request.json

{
    "product_id": "FROM_PRODUCTS",
    "lines": [
        {
            "location_id": "FROM_CATALOG",
            "time_id": "FROM_CATALOG",
            "quantity": 1
        }
    ],
    "promo_code": ""
}

अतिरिक्त उपयोग उदाहरण

ID और कीमतें उदाहरण मात्र हैं; कैटलॉग और उसी कोट के वास्तविक मान उपयोग करें। JSON ID और expected_total_minor संख्याएँ हों। सुरक्षा के लिए उदाहरणों में terms=false है; वास्तविक भुगतान वाले कार्य के लिए ग्राहक की स्पष्ट सहमति के बाद ही terms=true भेजें।

एक उत्पाद प्रकार, दो देश

quote की पंक्तियों में उद्देश्य न भेजें: location_id, time_id और quantity पर्याप्त हैं। उद्देश्य purchase चरण में अनिवार्य है।

application/json

{
    "product_id": 5,
    "lines": [
        {
            "location_id": 10,
            "time_id": 101,
            "quantity": 1
        },
        {
            "location_id": 11,
            "time_id": 102,
            "quantity": 1
        }
    ],
    "promo_code": ""
}

अनुरोध उदाहरण

cURL

printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
  curl --silent --show-error --header @- \
    --header 'Accept: application/json' \
    --connect-timeout 10 --max-time 30 \
    --request POST --header 'Content-Type: application/json' \
    --data-binary @request.json \
    'https://www.arnproxy.com/account/api/v1/quote'

इस पेज पर उदाहरण नहीं चलते। API कुंजी सर्वर की पर्यावरण चर में रखें, URL या ब्राउज़र कोड में नहीं। POST के लिए request.json तैयार करें।

उत्तर

200सफल उत्तर

application/json

{
    "ok": true,
    "data": {
        "product": {
            "id": 5,
            "name": "IPv4 Proxy",
            "minimum_quantity": 1
        },
        "currency": "TRY",
        "quantity": 1,
        "base_total": "10.00",
        "quantity_discount_amount": "0.00",
        "subtotal": "10.00",
        "promotion": {
            "code": "",
            "rate": "0.00",
            "amount": "0.00"
        },
        "total": "10.00",
        "total_minor": 1000,
        "lines": [
            {
                "location_id": 10,
                "country": "Example country",
                "time_id": 101,
                "period": "7 days",
                "days": 7,
                "quantity": 1,
                "base_unit_price": "10.0000",
                "quantity_discount_rate": "0.00",
                "unit_price": "10.0000",
                "base_total": "10.00",
                "subtotal": "10.00",
                "promotion_amount": "0.00",
                "total": "10.00",
                "total_minor": 1000
            }
        ],
        "discount_scope": "country",
        "estimate_only": true,
        "stock_checked": false,
        "purchase_available": false,
        "calculated_at": "2030-01-01T12:00:00+00:00"
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}

उत्तर के फ़ील्ड और प्रकार

नाम	प्रकार	विवरण
`ok`	`boolean`	सफलता संकेत; false पर error.code देखें।
`data`	`object`	कार्रवाई-विशिष्ट परिणाम; उदाहरण कृत्रिम और समझाने के लिए हैं।
`data.product`	`object`	product का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.product.id`	`integer`	संबंधित ARNPROXY रिकॉर्ड ID; आंतरिक प्रदाता ID के बदले इसे लें।
`data.product.name`	`string`	name का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.product.minimum_quantity`	`integer`	इस उत्पाद की प्रति ऑर्डर पंक्ति न्यूनतम मात्रा।
`data.currency`	`string`	खाते की लेनदेन मुद्रा: TRY या USD।
`data.quantity`	`integer`	चुने या ऑर्डर किए प्रॉक्सी की संख्या।
`data.base_total`	`string`	धनराशि; शुद्धता के लिए लौटाया पाठ/पूर्णांक प्रारूप बनाए रखें।
`data.quantity_discount_amount`	`string`	quantity discount amount का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.subtotal`	`string`	धनराशि; शुद्धता के लिए लौटाया पाठ/पूर्णांक प्रारूप बनाए रखें।
`data.promotion`	`object`	promotion का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.promotion.code`	`string`	code का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.promotion.rate`	`string`	rate का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.promotion.amount`	`string`	धनराशि; शुद्धता के लिए लौटाया पाठ/पूर्णांक प्रारूप बनाए रखें।
`data.total`	`string`	धनराशि; शुद्धता के लिए लौटाया पाठ/पूर्णांक प्रारूप बनाए रखें।
`data.total_minor`	`integer`	लघुतम मुद्रा इकाई में पूर्णांक: 1000 = 10.00 TRY/USD।
`data.lines`	`array`	lines का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.lines[]`	`object`	lines का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.lines[].location_id`	`integer`	स्थानीय कैटलॉग स्थान या उत्पाद प्रकार ID।
`data.lines[].country`	`string`	country का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.lines[].time_id`	`integer`	स्थानीय अवधि/GB प्लान ID, दिनों या GB की गिनती नहीं।
`data.lines[].period`	`string`	पढ़ने योग्य कैटलॉग अवधि नाम।
`data.lines[].days`	`integer`	प्लान अवधि दिनों में, GB प्लान की ट्रैफ़िक मात्रा से अलग।
`data.lines[].quantity`	`integer`	चुने या ऑर्डर किए प्रॉक्सी की संख्या।
`data.lines[].base_unit_price`	`string`	base unit price का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.lines[].quantity_discount_rate`	`string`	quantity discount rate का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.lines[].unit_price`	`string`	unit price का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.lines[].base_total`	`string`	धनराशि; शुद्धता के लिए लौटाया पाठ/पूर्णांक प्रारूप बनाए रखें।
`data.lines[].subtotal`	`string`	धनराशि; शुद्धता के लिए लौटाया पाठ/पूर्णांक प्रारूप बनाए रखें।
`data.lines[].promotion_amount`	`string`	promotion amount का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.lines[].total`	`string`	धनराशि; शुद्धता के लिए लौटाया पाठ/पूर्णांक प्रारूप बनाए रखें।
`data.lines[].total_minor`	`integer`	लघुतम मुद्रा इकाई में पूर्णांक: 1000 = 10.00 TRY/USD।
`data.discount_scope`	`string`	discount scope का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.estimate_only`	`boolean`	estimate only का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.stock_checked`	`boolean`	कीमत/स्थानीय परिणाम अकेले प्रदाता या स्टॉक की गारंटी नहीं।
`data.purchase_available`	`boolean`	शर्तों/अनुमतियों के अनुसार उपलब्धता, स्टॉक या प्रदाता की गारंटी नहीं।
`data.calculated_at`	`string`	API के लौटाए प्रारूप में समय; उदाहरण की तारीखें कृत्रिम हैं।
`meta`	`object`	अनुरोध संबद्धता और डेटा-स्रोत मेटाडेटा।
`meta.request_id`	`string`	इस HTTP अनुरोध की पहचान; कार्रवाई कुंजी या ऑर्डर ID नहीं।
`meta.phase`	`string`	phase का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`meta.source`	`string`	डेटा स्रोत; स्थानीय रिकॉर्ड और लाइव प्रदाता क्वेरी अलग प्रमाण हैं।

त्रुटि उत्तर

HTTP 401 · INVALID_API_KEY

{
  "ok": false,
  "error": { "code": "INVALID_API_KEY" },
  "meta": { "request_id": "000000000000000000000001" }
}

प्रमाणीकरण और जाँच निष्पादन से पहले अनुरोध रोक सकते हैं। त्रुटि संदर्भ देखें और सहायता के लिए request_id रखें। कुंजी या पासवर्ड न भेजें। त्रुटियाँ और सीमाएँ →

व्यवहार और महत्वपूर्ण नोट

ID products/catalog से लें। quote पंक्ति में केवल location_id, time_id, quantity। purchase में purpose_id=201 और चुना subpurpose_id भी आवश्यक।
quote की पंक्तियों में उद्देश्य न भेजें: location_id, time_id और quantity पर्याप्त हैं। उद्देश्य purchase चरण में अनिवार्य है।
एक product_id में अधिकतम 20 अलग location_id हो सकते हैं। हर देश की अलग ऑर्डर प्रविष्टि बनती है; जुड़ा हुआ चेकआउट एक इनवॉइस में संसाधित होता है। मात्रा छूट हर देश की अपनी मात्रा पर लगती है।