Developers

Reference

Markdown

Changelog

Each API version is named by its release date and returned in the x-larm-api-version header. Additive changes ship at any time; breaking changes are announced at least 12 months ahead.

  1. Current

    • Full orders in orders:read: line items, amounts, currency, payment status and order link, with status, payment and date filters.
    • New scopes: customers:read for the customer name, E.164 phone and address, orders.digital:read for delivered digital content, and carts:read for abandoned carts.
    • Order events: order.created, order.paid, order.status.updated, order.refunded, order.digital.delivered and abandoned_cart.created.
    • The x-larm-endpoint-id header on installation and privacy webhook deliveries, which the data-deletion acknowledgement needs.
    • Payments are outcome-only: GET /payments returns id, order_id, status (succeeded or failed) and created_at. The provider, amount and currency fields were removed, and orders no longer carry payment_method.

    • Expanded catalog of 27 scopes separating reading, editing, publishing and deletion.
    • Store pages, coupon status, review moderation, redacted order/payment summaries, and granular media, SEO and reporting scopes.
    • Existing installation grants remain unchanged; new access requires version approval and merchant consent.

    • First dated version of the LARM stores API v1: products, categories, physical inventory, analytics and webhook subscriptions.
    • Every public API response carries the x-larm-api-version header.
    • Developer test stores on the sandbox service, with sample data and test payments that never move money.
    • Webhook tools in the developer portal: seven-day delivery log, a test event per topic, single-delivery replay and an alert before automatic pausing.

    ↑↓ moveEnter openEsc close