LinxcommerceWebapiSdk TypeScript SDK 1.0.0

Welcome to the LinxcommerceWebapiSdk SDK documentation. This guide will help you get started with integrating and using the LinxcommerceWebapiSdk SDK in your project.

This SDK was generated by Postman

Versions

• SDK version: 1.0.0

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Setting a Custom Timeout
• Sample Usage
• Services
• Models

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: TypeScript >= 4.8.4

Installation

To get started with the SDK, we recommend installing using npm or yarn:

npm install linxcommerce-webapi-sdk

or

yarn add linxcommerce-webapi-sdk

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

const linxcommerceWebapiSdk = new LinxcommerceWebapiSdk({ timeout: 10000 });

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

import { LinxcommerceWebapiSdk } from 'linxcommerce-webapi-sdk';

(async () => {
  const linxcommerceWebapiSdk = new LinxcommerceWebapiSdk({});

  const data = await linxcommerceWebapiSdk.customers.consumerDetail({
    customerId: '{{CustomerID}}',
    sessionId: '{{SessionID}}',
  });

  console.log(data);
})();

Services

The SDK provides various services to interact with the API.

| Name | | :----------------------------------------------------------------------------- | | CustomersService | | ProductsService | | AddressService | | DeliveryService | | BasketService | | CheckoutService | | OrdersService | | WsService | | WidgetService | | OndeEncontrarJsonService |

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

| Name | Description | | :--------------------------------------------------------------------------------------------------- | :---------- | | CreateConsumerRequest | | | CreateConsumerRequestCustomer | | | CustomerContact1 | | | CreateBusinessAccountRequest | | | CreateBusinessAccountRequestCustomer | | | CustomerContact2 | | | Addresses | | | ExtendedProperties | | | HtmlAttributes | | | LoginRequest | | | RecoverPasswordRequest | | | ProductsDatasourceRequest | | | BrandsRequest | | | RetornaOpODeEntregaParaOmsRequest | | | DetailsOrderRequest | | | AccountOrderRequest | |