API Reference

🛍️Integrating as Sales Channel

Using the API for a Sales Channel/E-Commerce

When you integrate your platform as a Sales Channel, it connects directly with the Neomode OMS, enabling you to:

🛍️Go to the Order Actions

  • Create and manage customer orders seamlessly.
  • Track and receive updates on invoices, shipments, and delivery statuses.

📦Go to the Catalog Actions

  • Access and synchronize the complete product catalog.
  • Stay up to date with real-time price and stock changes.

Below, you’ll find a detailed step-by-step guide for each integration flow.

🛍️Order Actions

Defines the possible operations that can be performed on an order within the system.


1. Freight Simulation

This route performs a delivery simulation based on the items and the destination zip code.
It returns the available shipping options, including information such as delivery time, cost, and the originating store that can fulfill the order.

This step is fundamental in the order creation flow because:

It defines the eligible stores to fulfill the shopping cart;

It allows the sales channel to select the best shipping option (lowest cost, shortest delivery time, etc.);

It ensures that the order is created consistently and linked to the correct logistics operation.

  1. Simulate shipping to identify stores and delivery options. – POST Freight Simulation
  2. Select the desired option (e.g., store + delivery type).
  3. Create the external order based on this selection.

❗The shipping quote does not automatically create the order — it only identifies the possible conditions and origins.


2. Create External Order

Create an order in the Neomode OMS using the customer's selection and payment intent.


3. Approve Payment

Once the transaction has been confirmed by the Sales Channel:

  1. Send transaction confirmation information such as NSU, brand, and others. – PUT Payment

4. Check order separation and shipping information

Consume the separate information (NF-e) made available by the ERP.

  1. Obtain a valid token – Authenticate
  2. Get Orders by Seller – GET Orders by a Seller
  3. Get invoice details by order.id – GET Order Invoice by Guid Id

📦 Consume Catalog Data

Synchronize all product information while staying up to date with real-time price and inventory changes.


1. Fetch Products Flow

Initial load and synchronization flow

  1. Obtain a valid access token. – Authenticate
  2. Fetch updated products identifiers that were updated after a specific timestamp. – GET Products Updated
  3. Fetch product details by ID
    For each product returned in the previous step, retrieve the complete product data using its identifier.
    – GET Product by ID (details endpoint)

Notes to initial load

📘

Rules to initial load

  • The initial load should always start by calling Products Updated using the environment creation date to retrieve all created products.
  • After the initial load, consumers should store the latest lastUpdate value and reuse it for incremental synchronization.
  • The Products Updated endpoint acts as a change detector and does not return full product data.
  • Full product details must always be retrieved through the Get Product by ID endpoint.