ChemPare Documentation - v0.0.0
    Preparing search index...

    Module types/macklin

    Interfaces

    MacklinApiResponse

    Base response wrapper for all Macklin API responses. All API endpoints return data in this format, with a status code, message, and typed data payload.

    TimestampResponse

    Response from the timestamp endpoint used for request signing. This timestamp is critical for API authentication and must be synchronized with the server.

    TimestampStorage

    Local storage structure for timestamp synchronization. Stores both server and client timestamps to detect drift and trigger resynchronization when needed.

    MacklinApiRequestOptions

    Configuration options for making requests to the Macklin API. Supports both GET and POST/PUT requests with optional headers, URL parameters, and request body.

    MacklinApiSuccessResponse

    Successful API response with additional metadata. Used internally to track response headers and status codes for debugging and error handling.

    MacklinRequestHeaders

    HTTP headers required for Macklin API requests. All requests must include these headers for authentication and request signing. The sign header is added automatically by the client.

    MacklinApiError

    Extended Error type for Macklin API errors. Includes additional error metadata like error codes and HTTP status codes for better error handling.

    MacklinProduct

    Represents a Macklin product in the search results. Products are indexed by their CAS number, with each CAS number potentially having multiple variants (e.g., different purities, packaging sizes, etc.).

    MacklinProductVariant

    Represents a single variant of a Macklin product. Contains detailed information about a specific product variant, including chemical properties, specifications, and identifiers.

    MacklinProductDetails

    Detailed product information returned by the product details endpoint. Contains comprehensive information about a specific product variant, including pricing, stock levels across different warehouses, and delivery information.

    MacklinSearchResult

    Search results wrapper containing a list of products and total count. The list property is generic to support different product representations (e.g., MacklinProduct for search results, MacklinProductDetails for detailed product information).

    Type Aliases

    MacklinSearchResultProducts
    MacklinProductDetailsResponse