API Reference

🏪Integrating as POS/ERP

Using the API for a POS/ERP

When you integrate your system as POS/ERP, you establish a direct connection with the Neomode platform to:

Below, we explain step-by-step how each integration stage works.

📦Go to the Catalog Integration Flow

  • Publish and keep the product catalog updated (categories, products, and SKUs).
  • Send price and stock updates asynchronously.

🏪Go to the Order Integration Flow

  • Manage orders received from connected channels — from retrieval to invoicing and tracking.

📦Catalog Integration Flow

Catalog updates must be submitted in batches and will be processed asynchronously.


1. Register the category tree

The category structure is hierarchical and should be created level by level.

  1. With a valid token – Authenticate
  2. Send the first level of the category tree asynchronously – PUT Upsert Batch Categories
  3. Retrieve the ID of the created category searching by your code – GET Category
  4. Send the second level, using the parentId of the upper-level category asynchronously – PUT Upsert Batch Categories

Send Top-Level Categories

Send Other Level Categories

🔗 More details about category hierarchy


2. Send Products and SKUs

The submission should be done in batch with the complete set (product and SKUs).

  1. Whit a valid token – Authenticate
  2. Send products and SKUs asynchronously – PUT Upsert Batch Products

🔗 More details about Product and SKU Catalog


3. Send Price Updates

Price updates must be sent in batches and are processed asynchronously.

  1. Whit a valid token – Authenticate
  2. Send prices asynchronously – PUT Upsert Batch Prices

It is important to set the Match Codes via query parameters for data persistence to occur successfully.

Stocks Batch query parameter options:

  • ProcuctMatchCode: code, auxCode, referenceCode, id
  • SellerMatchCode: cnpj, pointsaleid, id

4. Send Stock Updates

Stock updates must be sent in batches and are processed asynchronously.

  1. Whit a valid token – Authenticate
  2. Send stocks asynchronously – PUT Upsert Batch Stocks

It is important to set the Match Codes via query parameters for data persistence to occur successfully.

Stocks Batch query parameter options:

  • SkuMatchCode: code, auxCode, barcode
  • SellerMatchCode: cnpj, pointsaleid, id

🏪Order Integration Flow

After confirmation of order captured by ERP/POS, progress must be notified


1. Search for New Orders

Fetch orders placed on connected channels, including customer, product, payment, and delivery information. Notify the channel that the order has been received and is being processed.

  1. Whit a valid token – Authenticate
  2. Fetch orders with status 2 (PendingCreate) by store and date range – GET Orders By Seller

The ERP must query orders by store (defined in the path parameter) at intervals defined by query parameters.

📘

Paid vs. Unpaid Orders:

By default, status 2 (PendingCreate) represents paid orders.

You can configure the system to display newly created unpaid orders. Contact our team.

2. Confirm Order Picking

  1. Whit a valid token – Authenticate
  2. Insert the ERP order identifier as sellerOrderId – PUT SellerOrderId
  3. Send status 4 (ApprovedExternal) – PUT Status by SellerOrderId

Steps 1 and 2 are usually done together


3. Send Invoice Data

Submit electronic invoice (NF-e) details.

  1. Whit a valid token – Authenticate
  2. Submit invoice data using order.id – PUT Order Invoice by Guid Id

You can either send the hosted document URL or the full document encoded in Base64.


4. Send Delivery Information

Update the delivery status and send the tracking code and carrier information.

  1. Whit a valid token – Authenticate
  2. Submit delivery data using order.id – PUT Tracking By Id
  3. Send status '7' (InDelivery) – PUT Status by SellerOrderId

5. Finalize Order

  1. Whit a valid token – Authenticate
  2. Send status 9 (Finalized) – PUT Status by SellerOrderId