Skip to main content

Why We're Moving to v3

Joe Longstreet

Version 3 of the Nabis Customer API is part of a larger project at Nabis: moving all of our operations onto a new, modern platform. This post explains why we're making the change, what's different, and what new things you can do with v3.

Why a new version​

The systems behind our California operations were built early in Nabis' history. As we grew, they got harder to extend, and changes in one area could have unexpected effects in another. We've rebuilt that foundation on a single, modern platform that serves every market we operate in.

v3 of the Customer API is built directly on that new platform. That means faster improvements, more consistent data, and an API that's easier for us to support and grow over time.

What stays the same​

The core of the API hasn't changed. If you have a v2 integration today, these all work the same way in v3:

Why some field names changed​

Some fields have new names in v3. For example, sku is now item, skuBatch is now itemBatch, and standardPricePerUnit is now itemPricePerUnit.

These names now match the names Nabis uses everywhere else, across our own platform and internal tools. That consistency makes the API easier for us to maintain, and means the terms you see in the API line up with how our team talks about your data. A new major version is the right time to make a change like this, so we're doing it once, now.

The Migrating from v2 guide lists every renamed field.

One API for every market​

In v2, the endpoints you could use, and the fields they returned, depended on the US state. For example, the invoices endpoint wasn't available in New York at all.

In v3, there's one set of endpoints with the same fields for every organization. Your API key identifies your organization, so you no longer need to choose between state-specific endpoints. If you sell in more than one market, you only need one integration.

What's new​

Retailer credit history​

In v2, a retailer included its current credit rating and the one before it. If a rating changed more than once between your API calls, the earlier history was lost, and there was no way to get it back.

The new retailer credit history endpoint gives you the full record of a retailer's credit ratings over time, including when each change happened.

Line items have their own endpoint​

In v2, line items came back as part of each order. In v3, orders and line items are separate: /v3/orders returns one record per order, and /v3/line-items returns the line items.

This makes responses smaller and faster, and makes it easy to answer questions that were hard before. For example, to find every order that includes a specific item:

curl "https://customer-api.nabis.pro/v3/line-items?page=0&limit=100&itemId=<item-id>" \
-H 'x-nabis-access-token: <access-token>'

Having a dedicated line items endpoint also gives us room to add more ways to search line items in the future.

One source of truth for financials​

In v2, both orders and invoices included financial details like subtotals, discounts and taxes. In v3, financial details live only on invoices, so there's one place to look and the numbers are always consistent.

Filter invoices​

The invoices endpoint now has filters, so you can request just the invoices you need:

  • orderId: invoices for a single order
  • groupType: only order invoices (ORDER) or only fee invoices (FEE, BASE)
  • paymentStatus: for example, only UNPAID invoices
  • startDueDate and endDueDate: invoices due in a date range

Filters can be combined. For example, to list unpaid invoices that are past due:

curl "https://customer-api.nabis.pro/v3/invoices?page=0&limit=100&paymentStatus=UNPAID&endDueDate=2026-11-11" \
-H 'x-nabis-access-token: <access-token>'

Filter retailers​

You can now filter retailers by:

  • isOnMarketplace: whether the retailer can order from you on the Nabis marketplace, based on your blocklist
  • creditClass: the retailer's current credit rating, for example GOOD

Combine endpoints to answer bigger questions​

Because orders, line items, invoices and credit history are now separate endpoints that link to each other by ID, you can combine them to answer questions that weren't possible in v2. For example: which retailers have past-due invoices and have ever had a poor credit rating?

  1. Get past-due invoices from /v3/invoices with paymentStatus=UNPAID and endDueDate set to today.
  2. Look up each invoice's order with /v3/orders/{orderId} to get the retailer's licensedLocationId.
  3. Check each retailer's /v3/retailers/{id}/credit-history for a POOR rating.

Getting help​

The Migrating from v2 guide covers every change in detail. If you run into timeouts, access issues or date formatting errors, see Troubleshooting. For anything else, reach out to help@nabis.com.