Store

The Store module handles store configuration, subscription management, team access, and webhooks.

Get Store

Retrieve the current store.

const store = await sdk.store.getStore({});

console.log(store.key, store.settings);

List Stores

List all stores the current user has access to.

const result = await sdk.store.getStores({
query: 'store',
isNetwork: false,
status: 'ACTIVE',
limit: 20,
cursor: null,
sort_field: 'created_at',
sort_direction: 'desc'
});

result.items.forEach(store => {
console.log(store.key);
});

Create Store

Create a new store.

const result = await sdk.store.createStore({
key: 'my-store',
timezone: 'America/New_York',
billing_email: '[email protected]',
languages: [{ id: 'en' }],
emails: {
  billing: '[email protected]',
  support: '[email protected]'
}
});

Two default markets are auto-created with every store: us (USD, Exclusive) and eu (EUR, Inclusive). Fetch them with sdk.market.list() or create additional markets with sdk.market.create().

Update Store

Update store settings.

const result = await sdk.store.updateStore({
id: 'store_abc123',
key: 'my-updated-store',
timezone: 'America/New_York',
languages: [{ id: 'en' }],
emails: {
  billing: '[email protected]',
  support: '[email protected]'
}
});

Delete Store

Permanently delete a store and all associated data.

await sdk.store.deleteStore({
	id: "store_abc123",
});

Subscriptions

Get Subscription Plans

List available subscription plans.

const plans = await sdk.store.getSubscriptionPlans({});

plans.forEach((plan) => {
	console.log(plan.name, plan.price, plan.features);
});

Subscribe to Plan

Subscribe a store to a plan. Returns a Stripe checkout URL for payment.

const result = await sdk.store.subscription.subscribe({
plan_id: 'plan_pro',
action: 'select_plan',
success_url: 'https://yourapp.com/subscription/success',
cancel_url: 'https://yourapp.com/subscription/cancel'
});

// Redirect to Stripe checkout
if (result.url) {
window.location.href = result.url;
}

Create Billing Portal Session

Create a Stripe Customer Portal session for subscription management.

const result = await sdk.store.createPortalSession({
	returnUrl: "https://yourapp.com/settings/billing",
});

// Redirect to Stripe portal
window.location.href = result.url;

Team Management

Add Member

Add a user to the store team immediately. If the account does not exist yet, it is created with the assigned store role. No confirmation email or accept step is sent.

await sdk.store.addMember({
email: '[email protected]',
role: 'admin'  // 'admin' | 'owner' | 'super'
});

Remove Member

Remove a team member from the store.

await sdk.store.removeMember({
	account_id: "acc_abc123",
});

Webhooks

Test Webhook

Send a test webhook to verify your endpoint configuration.

await sdk.store.testWebhook({
webhook: {
  url: 'https://yourapp.com/webhooks',
  events: ['order.created', 'order.paid'],
  secret: 'whsec_...'
}
});

console.log('Webhook test sent successfully');

Media

Get Store Media

List all media files for a store.

const result = await sdk.store.getStoreMedia({
	id: "store_abc123",
	limit: 50,
	cursor: null,
	query: "product",
	mime_type: "image/jpeg",
	sort_field: "created_at",
	sort_direction: "desc",
});

result.items.forEach((media) => {
	console.log(media.id, media.url);
});

Refunds

Process Refund

Process a refund for a payment.

await sdk.store.processRefund({
id: 'store_abc123',
entity: 'ord_xyz789',  // Order ID
amount: 1999  // Partial refund in cents
});

Build Hooks

Build hooks are store deploy endpoints. Arky resolves build hook URLs and headers server-side when a workflow uses a deploy_webhook node.

List Build Hooks

const hooks = await sdk.store.listBuildHooks({
	store_id: "store_abc123",
});

hooks.forEach((hook) => {
	console.log(hook.key, hook.type, hook.active);
});

Create Build Hook

await sdk.store.createBuildHook({
	store_id: "store_abc123",
	key: "production-deploy",
	type: "vercel",
	url: "https://deploy.example.com/hooks/production",
	active: true,
});

Update Build Hook

await sdk.store.updateBuildHook({
	store_id: "store_abc123",
	id: "hook_xyz789",
	key: "production-deploy",
	type: "custom",
	url: "https://deploy.example.com/hooks/arky",
});

Payment Providers

const providers = await sdk.store.paymentProvider.list({
	store_id: "store_abc123",
});

const { onboarding_url } = await sdk.store.paymentProvider.connectStripe({
	store_id: "store_abc123",
	return_url: "https://admin.example.com/payments?stripe=return",
	refresh_url: "https://admin.example.com/payments?stripe=refresh",
});

window.location.href = onboarding_url;

Delete Build Hook

await sdk.store.deleteBuildHook({
	store_id: "store_abc123",
	id: "hook_xyz789",
});

Get Store Config

Get the active public config for a specific category. Payment config is intentionally small: storefronts need the publishable key and currency, while Arky keeps provider account routing on the server.

const paymentConfig = await sdk.store.getStoreConfig({
	store_id: "store_abc123",
	type: "payment",
});

// {
//   provider: 'stripe',
//   publishable_key: 'pk_live_...',
//   currency: 'usd'
// }

Managed Provider Surfaces

Webhook CRUD

Manage webhook endpoints programmatically.

List Webhooks

const webhooks = await sdk.store.listWebhooks({
	storeId: "store_abc123",
});

Create Webhook

await sdk.store.createWebhook({
	storeId: "store_abc123",
	key: "order-notifications",
	url: "https://yourapp.com/webhooks/orders",
	events: [{ event: "order.created" }, { event: "order.updated" }],
	headers: { "X-Custom-Header": "value" },
	secret: "whsec_my_secret",
	enabled: true,
});

Update Webhook

await sdk.store.updateWebhook({
	storeId: "store_abc123",
	id: "wh_xyz789",
	key: "order-notifications",
	url: "https://yourapp.com/webhooks/v2/orders",
	events: [
		{ event: "order.created" },
		{ event: "order.updated" },
		{ event: "order.cancelled" },
	],
	headers: {},
	secret: "whsec_new_secret",
	enabled: true,
});

Delete Webhook

await sdk.store.deleteWebhook({
	storeId: "store_abc123",
	id: "wh_xyz789",
});

Available Webhook Events