1.0.0 • Published 1 year ago

@haulsuite/livehaul-sdk v1.0.0

Weekly downloads
-
License
UNLICENSED
Repository
-
Last release
1 year ago

LiveHaul client library for JavaScript

Use the client library @haulsuite/livehaul-sdk in your application to

  • Integrate with Livehaul Application
  • Propagate changes in our system to LiveHaul in real time

Installation

Prerequisites

  • Node.js version >=12.13.1
  • Contact support to get the API Key

Install Package

Install the latest version for the LiveHaul client library using npm.

npm install @haulsuite/livehaul-sdk

Quick Start

Create instance of HaulMax

import {
  HaulMax,
  UpdateShipmentRequestDto
} from '@haulsuite/livehaul-sdk';

  const haulmax = new HaulMax('API_KEY', 'https://base-url.livehaul.io');
  const  updateShipmentDtos: UpdateShipmentRequestDto[] = [];
  //Populate updateShipmentDtos with appropriate values
  const updateShipmentResponse = await haulmax.postUpdateShipment(updateShipmentDtos);

Post Updated Shipment Details.

  const  updateShipmentDtos: UpdateShipmentRequestDto[] = [];
  //Populate updateShipmentDtos with appropriate values
  const updateShipmentResponse = await haulmax.postUpdateShipment(updateShipmentDtos);

Data Validation

This librabry also helps in running many of the validation checks before sending the request to LiveHaul. It helps in early detection of Data errors.

Support

Please reach out to LiveHaul support to report any issues or for any help!