OpenAPI definition (v0)

Lists articles. Returns either a full list or a paginated object when page and size are provided.

Create or update an article. If updated_at is absent, current time is used.

Upsert a batch of articles. Returns 202 if all succeed, otherwise 400 with details.

Returns a list of all unique metadata keys used across articles

Returns paginated list of all values for a specific metadata key

Full-text search across article SKU, name, and metadata fields.

Returns metadata about which fields are searchable (full-text) and filterable (exact match) for articles.

Marks an article as deleted at the specified time (or now).

Fetch a single article by SKU

Lists pricelists. If asOf is omitted, returns ALL pricelists including inactive (future/expired). If asOf is provided, returns only pricelists active at that timestamp. Always returns a paginated object with items, total, page, size.

Create or update a pricelist metadata entry

Upsert multiple pricelists in a single request

Returns a list of all unique metadata keys used across pricelists

Returns paginated list of all values for a specific pricelist metadata key

Returns paginated pricelists matching the provided PricelistSelection. Selection supports explicit pricelist codes and/or metadata key/value matches.

Full-text search across pricelist code, name, description, and metadata fields.

Returns metadata about which fields are searchable (full-text) and filterable (exact match) for pricelists.

Marks a pricelist as deleted at the specified time (or now). Returns {deleted:true, when:...} if successful.

Fetch a single pricelist by code

Soft deletes a price definition for a SKU/pricelist combination.

Administrative endpoint to list all currently active prices.

Upserts a single price definition with its quantity breaks.

Soft deletes multiple price definitions in a single request.

Upserts a list of price definitions in a single request.

Returns the total number of price records in the database.

Retrieves all pricelists that contain a price for the given SKU with full metadata. When tax_area and currency_code are provided, includes calculated prices (ex VAT and inc VAT).

Performs a best-price query for multiple SKUs across multiple pricelists.

Retrieves a list of all SKUs that have a price on the given pricelist. Supports both cursor-based (recommended) and page-based pagination. Use afterSku for cursor-based pagination (more efficient for large datasets).

Retrieves the raw price definition for a SKU on a pricelist, without tax application.

Retrieves the price for a single SKU on a specific pricelist and tax area.

List all pricelists that have an explicit bundle pricing rule for a given bundle SKU.

Remove the bundle pricing rule for a bundle SKU on a specific pricelist. Triggers recomputation (rule may now be inherited from parent, or bundle becomes unavailable).

Get the effective bundle pricing rule for a bundle SKU on a pricelist. Resolves rule inheritance by walking up the pricelist parent chain.

Set or update the bundle pricing rule for a specific bundle SKU on a pricelist. Triggers recomputation of the bundle price on this pricelist and all descendant pricelists.

List recent changes for a SKU on a pricelist over the last N days.

Returns a list of all tax areas

Create or update a tax area

Soft deletes a tax area by marking it as deleted at the specified time (or now)

Retrieves a single tax area by its code

Enables or disables a tax area. Inactive tax areas are not used for VAT calculations.

Returns a list of all VAT classes

Create or update a VAT class

Soft deletes a VAT class by marking it as deleted at the specified time (or now)

Retrieves a single VAT class by its code

Enables or disables a VAT class. Inactive VAT classes are not available for assignment.

List all registered webhook subscriptions.

Register a new webhook subscription for change notifications.

Deactivate a webhook subscription.

Get a webhook subscription by ID.

Update an existing webhook subscription.

Send a test event to the webhook endpoint.

List Article-TaxClass mappings for a SKU as of time

Create or update VAT class assignment for a SKU in a tax area

List Article-TaxClass mappings for a tax area as of time

Soft delete mapping for SKU/tax area at specified time (or now)

Fetch VAT class mapping for a SKU in a tax area as of time

Returns a list of all VAT rates for a specific tax area as of a timestamp

Create or update a VAT rate for a VAT class in a tax area

Soft deletes a VAT rate by marking it as deleted at the specified time (or now)

Retrieves a single VAT rate for a specific VAT class in a tax area as of a timestamp

Returns the list of currency codes supported by the ECB feed

Create or update EUR to other currency exchange rates for a specific UTC date. Accepts a map of currency codes to exchange rates.

Fetches the latest daily exchange rates from European Central Bank (ECB) feed and persists them to the database

Retrieves the foreign exchange rate from base currency to quote currency as of a specific timestamp. Uses EUR as cross-currency when direct rate is not available.

List all settings as of an optional timestamp. If asOf is omitted, returns the latest values.

Returns metadata for all known settings including type, title, description, and default value. Used by the admin UI to render appropriate controls.

Delete (or mark deleted) a setting. If 'when' is provided, deletion is recorded at that time; otherwise now.

Fetch a single setting by key at an optional point-in-time.

Create or update a setting value. If updated_at is provided, the change is recorded at that time; otherwise now.

Returns a list of all currencies

Create or update a currency

Retrieves a single currency by its code

Enables or disables a currency. Inactive currencies are not available for use.