Skip to main content

Matt Carter

New fields for CA /order​

For the order endpoint, we have added three new fields related to credit memos:

  • creditMemoType - the selected type of credit memo applied to the order.
  • creditMemoNote - the note entered for the credit memo applied to the order.
  • creditMemoCreatedBy - the user who created the credit memo.

These new fields are nullable strings. If no credit memo has been applied to the order, the fields will be null.

New fields for CA /invoice​

For the invoice endpoint, we have added the same three fields related to credit memos:

  • creditMemoType - the selected type of credit memo applied to the order.
  • creditMemoNote - the note entered for the credit memo applied to the order.
  • creditMemoCreatedBy - the user who created the credit memo.

These new fields are nullable strings. If no credit memo has been applied to the order, the fields will be null.

Surabhi Khachar

We're excited to announce that the /inventory endpoint now includes additional product data fields to provide more detailed information about SKUs.

New Fields Available​

The following fields are now available in the inventory endpoint:

  • skuBrandName
  • skuProductLine
  • skuUnitsPerEach
  • skuConsumableUnitsPerEach
  • skuEachUnitOfMeasure
  • skuThcPotencyMeasurementType
  • skuContainerType
  • skuIsColdStorage
  • skuTHC
  • skuCBD
  • skuCBG
  • skuCBN
  • skuTHCV
  • skuCBC
  • skuDelta8THC
  • skuCBDV
  • skuTHCA
  • skuCBDA
  • skuCBNA
  • skuCBCA
  • skuTHCVA
  • skuCBDVA
  • skuDelta10THC
  • skuDelta9THC
  • skuThcPotencyMg
  • skuThcPotencyPercentage
  • skuCannabinoidTypeA
  • skuCannabinoidTypeB

For more detailed information about these fields and their usage, please refer to our Product Data Fields Documentation.

For API implementation details, view the Inventory API Reference.

These fields are only available in CA endpoints.

Surabhi Khachar

The /order endpoint now includes the Retailer Credit Rating.

This value reflects the relevant retailer's credit rating at the time of order placement ("createdAt"). If the corresponding retailer did not have a Nabis-derived credit rating at the time of order creation, the value will default to NOT_APPLICABLE.

For more details, view the Order API Reference for more detail.

Surabhi Khachar

The /retailer endpoint will now include "Previous Credit Rating" and "Previous Credit Rating Date".

If the retailer's historical data does not contain record of more than one rating, or if they do not have any historical rating data, their "previousCreditRating" value will default to "NOT_APPLICABLE" and corresponding date value would be null.

Retailer API Reference (get many and get one).

Joe Longstreet

Two new endpoints are now available - /retailer and retailer/:id.

The /retailer endpoint returns high level details about all the retailers in the Nabis ecosystem. Optional query parameters allow filtering retailers by their participation in the marketplace.

The /retailer/:id endpoint returns more detailed information about each retailer - including their license set and a few other details.

View the Retailer API Reference (get many and get one) for more detail.

Joe Longstreet

Two new fields are now available on the /order endpoints: lastNonPaymentDate and lastNonPaymentReason. Both fields are nullable dependent on whether a not the associated order has a lastNonPaymentReason. A last non payment reason can be any one of the following values:

DISCREPANCY_IN_PRICING_OF_PRODUCTS_RECEIVED
DISCREPANCY_IN_QUALITY_OR_NATURE_OF_PRODUCTS_RECEIVED
INSOLVENCY_RISK
INSUFFICIENT_FUNDS
ORDER_NEVER_RECEIVED
PICKUP_UNALIGNED_WITH_RETAILER_ACCOUNTING_PRACTICES
REPRESENTATIVE_CANNOT_FACILITATE_PAYMENT
RETAILER_ALLEGES_TO_HAVE_ALREADY_PAID_INVOICE_TO_BRAND
RETAILER_ALLEGES_TO_HAVE_ALREADY_PAID_INVOICE_TO_NABIS

Example excerpt from response​

{
  "lastNonPaymentDate": "2024-03-04T21:42:17.871Z",
  "lastNonPaymentReason": "DISCREPANCY_IN_PRICING_OF_PRODUCTS_RECEIVED"
}

Filtering orders by whether or not a last non payment reason exists is possible with the lastNonPaymentReason query parameter. To retrieve only orders which have a last non payment reason, use lastNonPaymentReason=true. To retrieve only orders which do not have a last non payment reason, use lastNonPaymentReason=false.

Filtering orders by a lastNonPaymentDate is now also possible. To retrieve only orders with a last non payment reason between January 1st 2024 and January 30th 2024, use startLastNonPaymentDate=2024-01-01&endLastNonPaymentDate=2024-01-30. This will automatically apply the lastNonPaymentReason filter, ensuring all returned orders have a last non payment.

View the Order API Reference (get many) for more detail.

Joe Longstreet

Two new fields are now available on the /order endpoints: retailerParentOrganization and retailerParentOrganizationId. Both fields are nullable dependent on whether a not the associated retailer has a parent organization.

Example excerpt from response​

{
  "retailerParentOrganizationId": "82b67224-9bc3-4099-9b2d-9e415c91e912",
  "retailerParentOrganization": "Retailer Parent Organization"
}

View the Order API Reference (get many and get one) for more detail.

Matt Carter
info

Please refer to the Date and Times documentation on exact input parameter and results formatting.

Parameters​

For the order endpoint, we have added two new query parameters to allow filtering results within a date range or single date. Note that the date filtering is inclusive of the provided date.

  • startUpdatedAt - starting point of the date range to filter results by (inclusive of the date)
  • endUpdatedAt - ending point of the date range to filter results by (inclusive of the date)

Response​

It will also return two new fields in the response, mirroring how createdAt is handled:

  • updatedDate - date portion of the field. Ex. 2024-04-20
  • updatedTimestamp - full timestamp. Ex. 2024-04-20T23:26:41.782Z

Example excerpt from response​

{
  "id": "82b67224-9bc3-4099-9b2d-9e415c91e912",
  "updatedDate": "2023-04-20", 
  "updatedTimestamp": "2023-04-20T23:26:41.782Z"
}

View the Order API Reference for more detail.