NHPProxy CLI & Library

This package provides a CLI and an API Library to integrate with NHP New Zealand. You can search products, check pricing, check stock availability, and pull order/invoice history.

Note

This tool is currently configured for NHP New Zealand (nhpnz.co.nz). However, it should also work on the Australian version of the site (nhp.com.au) with some minor domain and configuration tweaks.

CLI Usage

The CLI tool is powered by Deno. You can run it directly using nhp_cli.js (or via deno task cli).

Setup

Before running the CLI, you must configure your NHP login details. You can do this in one of two ways:

Option 1: credentials.json Create a credentials.json file in the root directory:

{
  "username": "your_email@example.com",
  "password": "your_password",
  "sellMarginMultiplier": 1.25
}

(Note: sellMarginMultiplier is optional. If provided, the CLI will calculate and display a sell price for products).

Option 2: Environment Variables Alternatively, you can export the following environment variables:

• NHP_USERNAME
• NHP_PASSWORD
• NHP_SELL_MARGIN (optional)

Once configured, the CLI will automatically log in on its first run and cache your session in cookies.json.

Commands

Authentication

• deno run -A nhp_cli.js login - Force login and refresh cookies.

Products & Pricing

• deno run -A nhp_cli.js search <query> - Search for products matching a query.
• deno run -A nhp_cli.js price <itemId...> - Get price and stock info for specific product(s).
• deno run -A nhp_cli.js csv <csvFile> - Get price and stock for products listed in a CSV file.

Orders & Invoices

• deno run -A nhp_cli.js orders [offset] [--brief] - Get order history. Optional search flags: --dateFrom, --dateTo, --purchaseNumber, --documentNumber, --orderNumber, --customerReference. Add --brief for a compact table view.
• deno run -A nhp_cli.js invoices [offset] [--brief] - Get invoice history. Accepts the same optional search flags as orders. Add --brief for a compact table view.
• deno run -A nhp_cli.js order <orderId> - Get detailed line items and shipping status for a specific order.
• deno run -A nhp_cli.js invoice <id> - Get detailed line items for a specific invoice.
• deno run -A nhp_cli.js po <query> - Search order history by PO Number.

Cart Management

• deno run -A nhp_cli.js cart add <sku> [qty] - Add item(s) to cart. Supports bulk adding (sku1:qty1 sku2:qty2).
• deno run -A nhp_cli.js cart list - View current items in the cart.
• deno run -A nhp_cli.js cart remove <sku_or_lineId> - Remove an item from the cart.
• deno run -A nhp_cli.js cart update <sku_or_lineId> <qty> - Update quantity of a cart item.
• deno run -A nhp_cli.js cart clear - Empty the entire cart.
• deno run -A nhp_cli.js cart upload <csvFilePath> - Upload a CSV file directly to the cart.

JSON Output

You can append --json to any command to receive the raw JSON response instead of the formatted terminal output. This is highly useful for chaining commands or piping data into other applications.

deno run -A nhp_cli.js orders 0 --purchaseNumber PO-12345 --json > orders.json

---

Library API Usage

You can also integrate this package directly into your own JavaScript applications.

Import the Library

In Deno (or standard ES module environments), simply import the entry point mod.js.

import { NHPClient } from "./mod.js";

Initialization

Create a new instance of the client. By default, it will attempt to read credentials from credentials.json (or environment variables) and persist session cookies to cookies.json.

const client = new NHPClient({
  // Optional configuration overrides:
  cookiePath: "./data/custom_cookies.json",
  credentials: {
    username: "your_email@example.com",
    password: "your_password",
  },
  silent: true, // Set to true to suppress internal console log messages
});

// Always call ensureLogin() before making API calls
await client.ensureLogin();

API Methods

searchProducts(query)

Searches for products matching a keyword.

const results = await client.searchProducts("battery");
console.log(results.widgets[0].content); // Array of products

getPriceAndStock(products)

Fetches the current pricing and stock availability (including local NZ and AU stock). Expects an array of objects containing itemId and qty.

const items = [
  { itemId: "TPHS25R5GM", qty: 1 },
  { itemId: "1756BA1", qty: 5 },
];
const pricingData = await client.getPriceAndStock(items);

// Example response mapping:
for (const prod of pricingData.ChildProducts) {
  console.log(`Buy Price: ${prod.AdjustedPriceWithCurrency}`);
  console.log(`NZ Stock: ${prod.OnHandQty}`);
}

getOrders(pageSize, offset, options)

Fetches the user's order history. The options object can include any combination of the following search filters: documentNumber, orderNumber, purchaseNumber, customerReference, dateFrom, dateTo.

// Get first 20 orders
const orders = await client.getOrders(20, 0);

// Search for a specific Purchase Order number and Date Range
const poOrders = await client.getOrders(20, 0, {
  purchaseNumber: "PO-12345",
  dateFrom: "01/12/2025",
  dateTo: "06/12/2025",
});

getInvoices(pageSize, offset, options)

Fetches the user's invoice history. The options object accepts the same search filters as getOrders.

const invoices = await client.getInvoices(20, 0, { dateFrom: "01/01/2026" });

getOrderDetails(orderId)

Fetches specific line items and shipping statuses for a given order ID.

const details = await client.getOrderDetails("ORDER_ID_HERE");
console.log(details);

getInvoiceDetails(invoiceId)

Fetches specific line items and pricing for a given invoice ID (Document Number).

const items = await client.getInvoiceDetails("SIN987654321");
console.log(items);

Cart Management

The library provides complete functionality to manage the user's shopping cart:

await client.addToCart("115797", 2);
const cart = await client.getCart();
await client.updateCartLineQuantity(cart.Lines[0].ExternalCartLineId, 5);
await client.removeCartLine(cart.Lines[0].ExternalCartLineId);
await client.clearCart();

// You can also upload CSV files directly to the cart
await client.uploadCartCsv("./bulk_order.csv");