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:
- Create and manage customer orders seamlessly.
- Track and receive updates on invoices, shipments, and delivery statuses.
- 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.
- Simulate shipping to identify stores and delivery options. – POST Freight Simulation
- Select the desired option (e.g., store + delivery type).
- 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.
- Submit the order data – POST Create Order
3. Approve Payment
Once the transaction has been confirmed by the Sales Channel:
- 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.
- Obtain a valid token – Authenticate
- Get Orders by Seller - GET Orders by a Seller
- Get invoice details via
order.id– GET Order Invoice by Guid Id
📦 Catalog Actions
Access and synchronize all product information while staying up to date with real-time price and inventory changes.
1. Consume Catalog Data
Synchronize your product catalog to reflect availability and attributes.
- Obtain a valid token – Authenticate
- Fetch the product and SKU list – GET Products and SKUs
2. Consume Stock Movements
Stay updated on inventory levels to ensure accurate sales.
- Obtain a valid token – Authenticate
- Fetch stock movements per SKU – GET Stock Changes
3. Consume Price Movements
Ensure that product pricing is aligned with what's available in the OMS.
- Obtain a valid token – Authenticate
- Fetch price changes per SKU – GET Price Changes