एंटरप्राइज़ API
ERP सिंक के लिए वर्शन्ड REST API. Authorization: Bearer gcn_live_… या gcn_test_… से प्रमाणित करें. Business डैशबोर्ड में कुंजियाँ बनाएँ.
नए हैं? पार्टनर ऑनबोर्डिंग चेकलिस्ट से शुरू करें.
बेस URL
/api/v1मशीन-पठनीय OpenAPI: /api/v1/openapi
Postman संग्रह: डाउनलोड / आयात
मुख्य एंडपॉइंट
GET /me— org + scopesGET|POST /listings,/listings/bulkGET|POST /inventory,/inventory/bulk(syncMode: upsert|replace)/freight,/freight/bulk·/depots,/depots/bulk·/storage,/storage/bulk·/manufacturers,/manufacturers/bulk·/ports,/ports/bulk/inquiries,/inquiries/{id}/reply/organization,/webhooks,/bulk/{jobId}
स्कोप
नई कुंजियाँ सभी स्कोप पाती हैं. डेटा मॉडल से सूक्ष्म प्रतिबंध संभव.
listings:readlistings:writeinventory:readinventory:writefreight:readfreight:writedepots:readdepots:writestorage:readstorage:writemanufacturers:readmanufacturers:writeports:readports:writeinquiries:readinquiries:writeorg:readorg:writewebhooks:managebulk:write
पार्टनर क्विकस्टार्ट
कैटलॉग सिंक (सभी मॉड्यूल), पूछताछ और वेबहुक के लिए चरणबद्ध curl उदाहरण:
docs/api-partner-guide.mdरेडीनेस जांच: /api/v1/ready
नोट्स
- असत्यापित संगठन: निर्माण एडमिन स्वीकृति तक
PENDINGरहते हैं. - सत्यापित संगठन: API निर्माण/अपडेट स्वतः
ACTIVEप्रकाशित होते हैं. - सुरक्षित ERP रिट्राई के लिए
externalId+Idempotency-Keyउपयोग करें. - बल्क अधिकतम 200 आइटम/अनुरोध; वेबहुक बैकऑफ़ के साथ अधिकतम 3 रिट्राई.
- वेबहुक HMAC-हस्ताक्षरित (
x-gcn-signature,x-gcn-timestamp).