@century-dosupply/century-catalog-service-sdk-ts v1.4.5

Century Catalog Service SDK for TypeScript

This package provides a standard development kit (SDK) for working with the Century Catalog Service API with TypeScript.

Installation

npm install @century-dosupply/century-catalog-service-sdk-ts

After installing the package, you can begin using the SDK by instantiating and configuring the ProductServiceClient instance:

import { CatalogServiceClientFactory } from "../CatalogServiceClientFactory";

const client = CatalogServiceClientFactory.createClient({
    host: 'https://catalog.century.do.supply' 
});

const listing = await client.listings.getListng('2711-b5a5');

Documentation

Fetching a listing summary

In cases where detailed representations of product sourcing assets are not necessary, use getListingSummary(). This endpoint returns an IListingSummary instance, a slimmed down version of IListing, describing the catalog listing attributes, such as pricing, stock availability, and lead time details, that are the most relevant to finance and e-commerce use cases.

It is highly recommended to use getListingSummary() wherever its output is sufficient to satisfy the use case. This endpoint is significantly more network-efficient than its getListing() and especially getListingWithCalculationDetails() counterparts.

const listingSummary = await client.listings.getListingSummary('1746-ob16');

Fetching a listing

Use getListing() when a complete representation of a listing and the sourcing assets that comprise its stock availability is necessary.

This endpoint returns a large amount of data pertaining to stock and sourcing options. It is strongly recommended to prefer getListingSummary() to getListing() unless this detailed sourcing information is necessary.

const listing = await client.listings.getListing('1746-ob16');

Fetching a listing with calculation details

Use getListingCalculationDetail() when a complete representation of the calculation process, including all of the sourcing and referencing resources that contributed to those calculations, is necessary.

This endpoint retruns a tremendous amount of data - in most cases, multiple megabytes of data. This endpoint should not be used unless this wealth of information is an absolute necessity for the use case.

const listingCalculationDetail = await client.listings.getListingCalculationDetail('1746-ob16');