Back to Arky

Platform

Platform-level data — currencies, workflow tools, webhook events

The Platform module provides global configuration data used across all stores.

Get Currencies

GET /v1/platform/currencies
SDK: sdk.platform.getCurrencies()

Get the list of supported currency codes.

const currencies = await sdk.platform.getCurrencies();
// ['USD', 'EUR', 'GBP', 'CAD', 'AUD', ...]

Get Workflow Tools

GET /v1/platform/workflow-tools
SDK: sdk.platform.getWorkflowTools()

Get the list of available workflow tools and their operation metadata.

const tools = await sdk.platform.getWorkflowTools();

tools.forEach(tool => {
  console.log(tool.id, tool.category);
});

Get Webhook Events

GET /v1/platform/events
SDK: sdk.platform.getWebhookEvents()

Get the list of all available webhook event types.

const { data: events } = await sdk.platform.getWebhookEvents();
// ['collection.created', 'entry.created', 'order.created', ...]