API reference

Account

Account endpoints provide access to invoice history, detailed line items, saved shipping addresses, and price label management for reporting and fulfillment.


GET /Account/Invoices

Retrieve invoice history for a specific date range. View invoice summary information including totals, dates, and status.

Parameters

The following request parameters are available:

ParameterDescription
dateFromStarting date from which invoices will be returned. Supported formats: 'mm/dd/yyyy' and 'yyyy-mm-dd'.
dateToEnding date up to which invoices will be returned. Supported formats: 'mm/dd/yyyy' and 'yyyy-mm-dd'.

Refresh Schedule

Data is refreshed 4 times daily.

Example

Request

const baseUrl = 'https://api.hlc.bike/us/v4.1'
const apiKey = process.env.HLC_API_KEY

const res = await fetch(
  `${baseUrl}/Account/Invoices?dateFrom=2026-01-01&dateTo=2026-01-31`,
  { headers: { Authorization: apiKey, language: 'en' } },
)

const invoices = await res.json()

Response

[
  {
    "InvoiceNo": "string",
    "InvoiceDate": "2026-02-02T20:28:55.758Z",
    "InvoiceTotal": 0
  }
]

GET /Account/Invoices/Details

Retrieve detailed line-item information for specific invoices. View individual product details, quantities, and pricing.

Parameters

The following request parameters are available:

ParameterDescription
invoiceNumbersComma-separated list of invoice numbers to retrieve.

Refresh Schedule

Data is refreshed 4 times daily.

Example

Request

const baseUrl = 'https://api.hlc.bike/us/v4.1'
const apiKey = process.env.HLC_API_KEY

const res = await fetch(
  `${baseUrl}/Account/Invoices/Details?invoiceNumbers=INV123,INV456`,
  { headers: { Authorization: apiKey, language: 'en' } },
)

const details = await res.json()

Response

[
  {
    "InvoiceNumber": "string",
    "BillingAddress": {
      "Street": "string",
      "City": "string",
      "State": "string",
      "ZipCode": "string"
    },
    "ShippingAddress": {
      "Street": "string",
      "City": "string",
      "State": "string",
      "ZipCode": "string"
    },
    "SalesId": "string",
    "InvoiceDate": "2026-02-02T20:28:55.761Z",
    "DueDate": "2026-02-02T20:28:55.761Z",
    "PaymentTerms": "string",
    "PONumber": "string",
    "InvoiceTotal": 0,
    "FreightCosts": 0,
    "HandlingFees": 0,
    "LineItems": [
      {
        "VariantNo": "string",
        "Description": "string",
        "UnitOfMeasure": "string",
        "Quantity": 0,
        "UnitPrice": 0,
        "LineTotal": 0
      }
    ],
    "Taxes": [
      {
        "TaxCode": "string",
        "TaxAmount": 0
      }
    ]
  }
]

GET /Account/Addresses

Retrieve saved shipping and billing addresses associated with the account. Returns addresses configured for order fulfillment and invoicing.

Parameters

No query parameters required beyond standard headers.

Refresh Schedule

Data is updated once per day.

Example

Request

const baseUrl = 'https://api.hlc.bike/us/v4.1'
const apiKey = process.env.HLC_API_KEY

const res = await fetch(`${baseUrl}/Account/Addresses`, {
  headers: { Authorization: apiKey, language: 'en' },
})

const addresses = await res.json()

Response

[
  {
    "ID": 0,
    "Type": "string",
    "Description": "string",
    "Street": "string",
    "City": "string",
    "State": "string",
    "ZipCode": "string",
    "CountryCode": "string",
    "PrimaryPhoneNumber": "string",
    "PrimaryPhoneExtension": "string"
  }
]

Previous
Orders
Next
Tools