Supplier API for supplier ERP integrations. Prefix /v1/supplier/, keys bk_sup_*.
Who this section is for
Audience: Supplier IT/ERP teams. Key bk_sup_* is bound to one legal entity — only your deliveries and codes.
How to work with this API
Typical cycle: nightly file upload chain, daily history reconciliation and activation reports. Poll incoming/get after import.
Base URL
- Production:
https://api-external.promanta.ru - Local:
http://localhost:7314
Authentication
X-Api-Key: bk_sup_… header. Supplier id is bound to the key.
Create the key in supplier drawer under Promo codes.
Request and response format
All methods are POST with JSON { "meta": {}, "data": {} }. Response: success, data, meta.
Methods by workflow
0. Start: verify API key
Smoke test after key issuance.
- Verify supplier API key binding —
POST /v1/supplier/profile/get
0.1. Supplier products
Only your SKUs. Create a product, then pass productId into the shipment.
- Supplier products list —
POST /v1/supplier/products/list - Supplier product card —
POST /v1/supplier/products/get - Create supplier product —
POST /v1/supplier/products/create
1. New code delivery
Two paths: file (create → upload-url → import) or JSON (codes/bulk-create). After completed — webhook and/or poll incoming/get.
- Create new code delivery —
POST /v1/supplier/incoming/create - Supplier file upload signed URL —
POST /v1/supplier/incoming/upload-url - Start supplier file import —
POST /v1/supplier/incoming/import - Upload promo code shipment (JSON) —
POST /v1/supplier/incoming/codes/bulk-create - Incoming import status —
POST /v1/supplier/incoming/get
2. History and summaries
ERP reconciliation: deliveries, accepted counts, status balances.
- Supplier incoming history —
POST /v1/supplier/incoming/list - Promo codes summary by status —
POST /v1/supplier/promo-codes/summary
3. Code lookup
Masked list for bulk data; full code for support only (audited).
- Supplier promo codes list —
POST /v1/supplier/promo-codes/list - Full promo code value —
POST /v1/supplier/promo-codes/get
4. Customer activations
Bulk report activations → redeemed. Max 1000 rows, Idempotency-Key required.
- Report one code activation —
POST /v1/supplier/usage/report - Bulk report code activations —
POST /v1/supplier/usage/report-bulk
MCP
Same operations via MCP at /mcp/internal, /mcp/supplier, /mcp/platform.
Request example (smoke test)
{
"meta": { "requestId": "smoke-001" },
"data": {}
}Response example
{ "success": true, "data": { "supplierId": "c219ef09-…", "name": "Промомед", "inn": "7701234567", "isActive": true } }cURL
curl -X POST "https://api-external.promanta.ru/v1/supplier/profile/get" \
-H "Content-Type: application/json" \
-H "X-Api-Key: bk_sup_YOUR_KEY" \
-d '{"data": {}}'