Skip to main content

OMS

Overview​

This type represents the set of operations available when initializing an integration with the OMS function exported by this package. It provides a set of functions to interact with the order management system and its related entities.

Functions​

getAvailability​

Retrieve the availability of a product by its ID.

Parameters​

id

type: string

The unique identifier for the product in the format required by the OMS.

Return Value​

type: Promise<Result<ProductAvailability>>

A promise that resolves to the result of the product availability.

getOrder​

Retrieve an order by its ID.

Parameters​

orderID

type: string

The unique identifier for the order in the format required by the OMS.

Return Value​

type: Promise<Result<OrderHistoryOrder>>

A promise that resolves to the result of the retrieved order detail.

getOrderHistory​

Retrieve the order history for the current logged in user context of the application.

Parameters​

None

Return Value​

type: Promise<Result<OrderHistory>>

A promise that resolves to the result of the order history.