SDK API reference
Published release: SDK 0.1.3 is publicly available on npm. Package installation does not activate new backend features.
The publicly available 0.1.3 package set is: @kordiva/sdk, @kordiva/checkout and @kordiva/react. Use @kordiva/sdk in Node server code for authenticated Store API calls; the two browser-safe helpers do not grant payment authority or Store API access.
All paths below are relative to the configured API origin. The SDK unwraps data and throws a sanitized KordivaError for failures.
| Method | Route | Result |
|---|---|---|
products.list(query?, options?) | GET /public/catalog/stores/:storeId/products | ProductPage: items, total, limit, offset |
products.get(productId, options?) | GET same base /products/:productId | Product |
categories.list(options?) | GET same base /categories | CategoryDetail[] |
attributes.list(options?) | GET same base /attributes | Attribute[] |
shippingMethods.list(options?) | GET same base /shipping-methods | ShippingMethod[], Business use |
checkout.createHosted(input, options?) | POST same base /checkout-sessions | LIVE CheckoutSession |
checkout.createTest(input, options?) | POST same base /test-checkout | TEST { environment, url } |
payments.confirm(query, options?) | GET same base /payment-confirmations | LIVE PaymentConfirmation |
subscriptions.get(id, options?) | GET /business/v1/stores/:storeId/subscriptions/:id | BusinessSubscription |
subscriptions.list(query?, options?) | GET /business/v1/stores/:storeId/subscriptions | SubscriptionPage |
checkout.createSubscription(input, options?) | POST /business/v1/stores/:storeId/subscription-checkouts | LIVE Business SubscriptionCheckout |
HostedCheckoutInput requires 1–50 lineItems and an 8–128-character idempotencyKey. Each item requires product UUID and integer quantity 1–50; variant UUID is optional. Optional fields: checkoutLanguage (mk/en), orderRef, customerRef (1–128 characters), HTTPS successUrl/returnUrl, expiresInMinutes (5–120, server default 30).
Confirmation needs at least one of session UUID, orderRef or idempotencyKey. Prefer the session UUID. Result states are paid, pending, expired; read isPaid and keep fulfillment eligibility separate. Replay responses may omit orderRef/customerRef: those properties are optional in the SDK type.
RequestOptions accepts signal. The browser package exposes checkoutHref(handoff, allowedOrigins, options?) and redirectToCheckout(handoff, allowedOrigins, navigate?, options?). CheckoutButton accepts onCheckout, allowedOrigins, onError, and optional children/pendingLabel/disabled/className/navigate/checkoutOptions. No public key-management, refund or payout method is exported.
Related guides
Section titled “Related guides”SDK · Checkout · Security · API
Business 0.1.3
Section titled “Business 0.1.3”subscriptions.get/list are store/environment-scoped reads; checkout.createSubscription creates a LIVE recurring checkout from a CMS recurring Checkout Link. No public subscription change/cancel or refund mutation is exported. Subscription amounts are integer minor units with uppercase ISO currency, separate from catalog decimals. See filters, identity and checkout inputs.
@kordiva/sdk/merchant-webhooks exports verifyMerchantWebhook for Business HMAC lifecycle events; @kordiva/sdk/webhooks remains the separate P-256 agentic order verifier. See Business events and raw-body verification. Business refunds use supported merchant controls, not an SDK refund method.