Skip to main content

Nlc Report Ep

POST 
/v1/nlc_report

NLC Report

Returns Net Landed Cost (NLC) report data for all inventory costing states within the specified date range.

Required Scopes (ia.r)

Request​

start_date: datetime
The start date for the NLC report period.

end_date: datetime
The end date for the NLC report period.


Response​

The response includes NLC data for each inventory costing state:

results: list[NLCReportRow]
A list containing NLC data for each inventory costing state, including:

Show Child Attributes

site_name: str
Site identifier in format "number-name" (e.g., "00001-Seattle").

site_number: str
Site identifier in format "number-name" (e.g., "00001-Seattle").

date: str
Date in mm/dd/yyyy format.

tank: str
Tank number identifier.

uom: str
Unit of measure from the store's market profile (e.g., "Gal" for gallons, "L" for liters). Defaults to "Gal" if profile not found.

grade: str
Product grade or type.

beginning_inventory: float
Beginning inventory volume (2 decimal places).

forecasted_sales: float
Forecasted sales volume (2 decimal places).

actual_sales: float
Actual sales volume (3 decimal places).

ending_inventory: float
Ending inventory volume (3 decimal places).

beginning_inv_nlc: float
Beginning inventory Net Landed Cost price per unit (3 decimal places).

frcst_nlc: float
Forecasted Net Landed Cost price per unit (3 decimal places).

cogs_nlc: float
Cost of Goods Sold Net Landed Cost price per unit (3 decimal places).

ending_inv_nlc: float
Ending inventory Net Landed Cost price per unit (3 decimal places).

errors: list[str]
Store numbers whose rows were dropped from results because no tank could be found for the row's product.

Responses​

Successful Response

{
  "results": [
    {
      "store_name": "string",
      "store_number": "string",
      "date": "string",
      "tank": 0,
      "uom": "string",
      "product": "string",
      "beginning_volume": 0,
      "ending_volume": 0,
      "beginning_value": 0,
      "ending_value": 0,
      "actual_sales_value": 0,
      "forecasted_sales_volume": 0,
      "actual_sales_volume": 0,
      "beginning_read_time": "2026-11-11T17:36:45.904Z",
      "ending_read_time": "2026-11-11T17:36:45.904Z",
      "stale": false,
      "stale_from": "2026-11-11T17:36:45.904Z",
      "stale_since": "2026-11-11T17:36:45.904Z"
    }
  ],
  "errors": [
    "string"
  ],
  "stale_icis": [
    {
      "inventory_costing_identifier": {
        "id": "string",
        "type": "store_product",
        "site_id": "string",
        "site": "string",
        "product_id": "string",
        "product": "string"
      },
      "stale_from": "2026-11-11T17:36:45.904Z",
      "stale_since": "2026-11-11T17:36:45.904Z"
    }
  ]
}
Loading...