Getting started

Nucleo is one platform with four modules — Brain, Catalog, Commerce and Intelligence — and every module has its own API host. The APIs on this site are the ones built for code that runs outside Nucleo:

• Your storefront sends shopper events to Catalog, shows the delivery promise before checkout, and embeds returns and parcel tracking.
• Your warehouse downloads the orders to ship, reports shipments and stock, and handles returns — with a T-Data or FFW compatible interface, so most warehouse systems connect without new development.
• Your website reads the pages and articles you publish with the Brain CMS.
• Your AI assistant (Claude, ChatGPT or your own agent) works on your company's data with the permissions of the person who connects it.

Everything a person does in the Nucleo app goes through private APIs that are not listed here: they can change with every release. If you need something that is not on this page, tell us what you are building.

Every request goes over HTTPS. Plain HTTP is not served.

Each API reference page shows its exact base URL. Some include a segment that identifies your store or site (for example the returns portal slug or the CMS workspace): you find it in Nucleo, on the settings page of the feature.

The quickest way to see Nucleo answer is the delivery promise: it is read-only, it uses a token that is safe to publish, and it answers in milliseconds.

1. In Nucleo, go to Settings > Orders > Shipping and delivery > Delivery promise.
2. Turn the delivery promise on and copy the token (npk_…).
3. Ask when one item would arrive in Italy:

curl "https://api-commerce.nucleoplatform.com/api/oms/v1/public/promise?token=$NUCLEO_PROMISE_TOKEN&country=IT&sku=TEE-BLK-M&qty=1&lang=en"

const url = new URL("https://api-commerce.nucleoplatform.com/api/oms/v1/public/promise");
url.search = new URLSearchParams({
  token: process.env.NUCLEO_PROMISE_TOKEN,
  country: "IT",
  sku: "TEE-BLK-M",
  qty: "1",
  lang: "en",
});

const res = await fetch(url);
const promise = await res.json();
console.log(promise.message);

<?php

$query = http_build_query([
    'token' => getenv('NUCLEO_PROMISE_TOKEN'),
    'country' => 'IT',
    'sku' => 'TEE-BLK-M',
    'qty' => 1,
    'lang' => 'en',
]);

$promise = json_decode(file_get_contents(
    "https://api-commerce.nucleoplatform.com/api/oms/v1/public/promise?$query"
), true);

echo $promise['message'], PHP_EOL;

The answer carries one option per shipping method, the order-by cutoff and a sentence ready to show:

{
  "country": "IT",
  "available": true,
  "options": [
    {
      "method": "standard",
      "status": "in_stock",
      "order_by": "2026-10-05T12:00:00+00:00",
      "delivery_from": "2026-10-06",
      "delivery_to": "2026-10-07",
      "message": "Order within 2 h 14 min, get it between Tuesday, 6 October and Wednesday, 7 October"
    }
  ],
  "message": "Order within 2 h 14 min, get it between Tuesday, 6 October and Wednesday, 7 October"
}

From here, read Authentication to pick the right credential for what you are building, then open the API reference of the product you need.

• JSON in and out, UTF-8, unless the API says otherwise (the FFW warehouse interface speaks XML).
• Dates are ISO 8601. Timestamps carry their offset (2026-10-05T09:46:00+00:00 or …Z); calendar dates are YYYY-MM-DD.
• Money is a decimal amount with an ISO 4217 currency code next to it.
• Countries are ISO 3166-1 alpha-2 codes (IT, DE), languages ISO 639-1 (en, it).
• SKUs are the ones in your Nucleo catalog, exactly as written there.
• Unknown fields in a response can appear at any time: ignore what you do not use. See Versioning.

Every API is described by an OpenAPI 3.1 file, the same file this reference is built from. Download it from the API page (or from the list of specifications) and import it into Postman, Insomnia or Bruno, or generate a typed client with your favourite generator.

Code samples on this site read credentials from environment variables ($NUCLEO_…). Keep real keys out of your source code and your repository.