LinxcommerceLayerSimpleSdk TypeScript SDK 1.0.0

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

This SDK was generated by Postman

Versions

• SDK version: 1.0.0

About the API

LinxCommerce

Contact Support: Name: Atendimento - Linx Commerce Email: [email protected]

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-layer-simple-sdk

or

yarn add linxcommerce-layer-simple-sdk

Setting a Custom Timeout

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

const linxcommerceLayerSimpleSdk = new LinxcommerceLayerSimpleSdk({ timeout: 10000 });

Sample Usage

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

import { LinxcommerceLayerSimpleSdk } from 'linxcommerce-layer-simple-sdk';

(async () => {
  const linxcommerceLayerSimpleSdk = new LinxcommerceLayerSimpleSdk({});

  const data = await linxcommerceLayerSimpleSdk.getCheck.getCheck({
    accept: 'application/json',
  });

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

Services

The SDK provides various services to interact with the API.

| Name | | :----------------------------------------------------------------------------------------------------------------------- | | GetCheckService | | GenerateAuthorizationService | | GetDeliveryMethodService | | GetMarketplaceConfigurationsService | | GetMarketplaceSeller3PStatusService | | GetMasterStatusService | | GetMetadataOptionService | | GetMetadataOptionByIntegrationIdService | | GetPropertyMetadataService | | GetPropertyMetadataByIntegrationIdService | | GetWebSiteService | | SearchEntityMetadataService | | SearchMetadataOptionService | | SearchPropertyMetadataService | | SearchWebSiteService | | GetInventoryProductService | | GetInventorySkuService | | SearchInventorySkuService | | SearchInventorySkuMovementService | | SearchInventorySkuWithParentIdService | | GetOrderPaymentActionsService | | GetTransactionService | | SearchTransactionsService | | GetMasterPriceListService | | GetPriceListService | | GetProductPriceService | | GetStockKeepUnitPriceService | | GetStockKeepUnitPricesService | | SearchPriceListsService | | SearchProductPriceService | | GetAssociationListService | | GetBrandService | | GetBundleService | | GetBundleBySkuService | | GetCatalogService | | GetCategoryService | | GetCategoryGroupService | | GetCategoryPropertiesService | | GetCategoryPropertyValuesService | | GetDeletedProductService | | GetDeletedSkuService | | GetFlagService | | GetMasterCatalogService | | GetMixService | | GetMixRelationService | | GetOfferService | | GetProductService | | GetProductAdditionalService | | GetProductAdditionalListService | | GetProductAuctionService | | GetProductAuctionBidsService | | GetProductBundleRelationService | | GetProductByIntegrationIdService | | GetProductCategoriesService | | GetProductConditionService | | GetProductDataSourceService | | GetProductDefinitionService | | GetProductIdBySkuIntegrationIdService | | CatalogGetProductPriceService | | GetProductPriceChangeService | | GetProductPriceChangesService | | GetProductsByIntegrationIdService | | GetProductSeoService | | GetSkuService | | GetSkuByIntegrationIdService | | GetSkUsByIntegrationIdService | | GetSupplierService | | GetTagService | | GetUnitOfMeasureService | | GetWarehouseService | | GetWarehouseByIntegrationIdService | | SearchAssociationListService | | SearchBrandsService | | SearchBundleService | | SearchCatalogService | | SearchCategoryService | | SearchCategoryGroupsService | | SearchFlagService | | SearchMixService | | SearchOffersService | | SearchProductService | | SearchProductAdditionalListsService | | SearchProductAdditionalsService | | SearchProductAuctionsService | | SearchProductConditionsService | | SearchProductDataSourceService | | SearchProductDefinitionsService | | SearchProductPricesService | | SearchProductReviewsService | | SearchProductShortDefinitionsService | | SearchSkuService | | SearchSupplierService | | SearchTagsService | | SearchWarehouseService | | SearchShipmentsService | | SearchSalesRepresentativeService | | SearchPaymentTermService | | SearchOrderStatusService | | SearchOrdersCandidatesService | | SearchOrdersBySellerService | | SearchOrdersService | | SearchOrderPackageService | | SearchFinancialOrderInfoService | | GetShipmentService | | GetSalesRepresentativeService | | GetQueueOrdersService | | GetPaymentTermService | | GetOrderStatusService | | GetOrderPaymentsService | | GetOrderPaymentService | | GetOrderPackageService | | GetOrderGroupByNumberService | | GetOrderGroupService | | GetOrderByNumberService | | GetOrderService | | DequeueQueueItemsService | | GetQueueService | | GetQueueItemQueuedTaskService | | GetQueueItemsCountService | | SearchQueueItemsService | | SearchQueuesService | | GetCouponService | | GetPromotionService | | SearchCouponService | | SearchPromotionsService | | AddCustomerRelationService | | AddProductsToWishlistService | | ApproveCustomerFileService | | CaptureGiftCertificateService | | CheckCredentialsService | | DeleteProductsFromWishlistService | | DeleteWishlistService | | GetCompanyService | | GetCustomerService | | GetCustomerFileService | | GetCustomerGroupService | | GetCustomerStatusService | | GetCustomerStatusByIntegrationIdService | | GetGiftCertificateService | | GetGiftCertificateBalanceService | | GetPersonService | | GetQueueCustomersService | | GetStatusModerationCustomerMarketplaceService | | RejectCustomerFileService | | RunCustomerTransitionService | | SaveCompanyService | | SaveCustomerService | | SaveCustomerAddressService | | SaveCustomerFileService | | SaveCustomerStatusService | | SaveGiftCertificateService | | SaveWishlistService | | SearchCustomerService | | SearchGiftCertificateService | | SearchWishlistService | | SearchWishlistShortService | | ShareWishlistService | | GetAllLocationSellerWebSiteService | | GetExternalSellerIDsService | | GetLocationSellerService | | GetPickupPointService | | MashupCheckCredentialsService | | MashupGetBrandService | | MashupGetBundleService | | MashupGetBundleBySkuService | | MashupGetCategoryService | | MashupGetProductService | | GetProductDataSourceMarketplaceService | | GetProductDataSourceMarketplaceListService | | EnqueueAnonymizeCustomerService | | EnqueueCustomerExportService | | UpdateFulfillmentService | | GetFulfillmentService | | SearchFulfillmentsService |

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 | | :----------------------------------------------------------------------------------------------------------------------------- | :---------- | | GenerateAuthorizationRequest | | | SearchEntityMetadataRequest | | | SearchEntityMetadataRequestPage | | | SearchMetadataOptionRequest | | | SearchMetadataOptionRequestPage | | | SearchPropertyMetadataRequest | | | SearchPropertyMetadataRequestPage | | | SearchWebSiteRequest | | | SearchWebSiteRequestPage | | | GetInventoryProductRequest | | | GetInventoryProductRequestErrors | | | GetInventorySkuRequest | | | GetInventorySkuRequestErrors | | | SearchInventorySkuRequest | | | SearchInventorySkuRequestPage | | | SearchInventorySkuMovementRequest | | | SearchInventorySkuWithParentIdRequest | | | SearchInventorySkuWithParentIdRequestPage | | | GetOrderPaymentActionsRequest | | | SearchTransactionsRequest | | | SearchTransactionsRequestPage | | | GetProductPriceGetProductPriceRequest | | | GetStockKeepUnitPriceRequest | | | SearchPriceListsRequest | | | SearchPriceListsRequestPage | | | SearchProductPriceRequest | | | SearchProductPriceRequestPage | | | GetCategoryGetCategoryRequest | | | GetCategoryPropertiesRequest | | | GetCategoryPropertyValuesRequest | | | GetMixRelationRequest | | | GetOfferRequest | | | GetProductAuctionBidsRequest | | | GetProductBundleRelationRequest | | | CatalogGetProductPriceGetProductPriceRequest | | | GetProductPriceChangeRequest | | | GetProductPriceChangesRequest | | | SearchAssociationListRequest | | | SearchAssociationListRequestPage | | | SearchBrandsRequest | | | SearchBrandsRequestPage | | | SearchBundleRequest | | | SearchBundleRequestPage | | | SearchCatalogRequest | | | SearchCatalogRequestPage | | | SearchCategoryRequest | | | SearchCategoryRequestPage | | | SearchCategoryGroupsRequest | | | SearchCategoryGroupsRequestPage | | | SearchFlagRequest | | | SearchFlagRequestPage | | | SearchMixRequest | | | SearchMixRequestPage | | | SearchOffersRequest | | | SearchOffersRequestPage | | | SearchProductRequest | | | SearchProductRequestPage | | | SearchProductAdditionalListsRequest | | | SearchProductAdditionalListsRequestPage | | | SearchProductAdditionalsRequest | | | SearchProductAdditionalsRequestPage | | | SearchProductAuctionsRequest | | | SearchProductConditionsRequest | | | SearchProductConditionsRequestPage | | | SearchProductDataSourceRequest | | | SearchProductDataSourceRequestPage | | | SearchProductDefinitionsRequest | | | SearchProductDefinitionsRequestPage | | | SearchProductPricesRequest | | | SearchProductPricesRequestPage | | | SearchProductReviewsRequest | | | SearchProductReviewsRequestPage | | | SearchProductShortDefinitionsRequest | | | SearchProductShortDefinitionsRequestPage | | | SearchSkuRequest | | | SearchSkuRequestPage | | | SearchSupplierRequest | | | SearchSupplierRequestPage | | | SearchTagsRequest | | | SearchTagsRequestPage | | | SearchWarehouseRequest | | | SearchWarehouseRequestPage | | | SearchShipmentsRequest | | | SearchShipmentsRequestPage | | | SearchSalesRepresentativeRequest | | | SearchSalesRepresentativeRequestPage | | | SearchPaymentTermRequest | | | SearchPaymentTermRequestPage | | | SearchOrderStatusRequest | | | SearchOrderStatusRequestPage | | | SearchOrdersCandidatesRequest | | | SearchOrdersCandidatesRequestPage | | | SearchOrdersBySellerRequest | | | SearchOrdersBySellerRequestPage | | | SearchOrdersRequest | | | SearchOrdersRequestPage | | | SearchOrderPackageRequest | | | SearchOrderPackageRequestPage | | | SearchFinancialOrderInfoRequest | | | SearchFinancialOrderInfoRequestPage | | | GetSalesRepresentativeRequest | | | GetQueueOrdersRequest | | | GetQueueOrdersRequestLockSpan | | | LockSpanValue1 | | | GetQueueOrdersRequestPage | | | GetOrderPaymentRequest | | | DequeueQueueItemsRequest | | | GetQueueItemQueuedTaskRequest | | | GetQueueItemsCountRequest | | | SearchQueueItemsRequest | | | SearchQueueItemsRequestLockSpan | | | LockSpanValue2 | | | SearchQueueItemsRequestPage | | | SearchQueuesRequest | | | SearchQueuesRequestPage | | | SearchCouponRequest | | | SearchCouponRequestPage | | | SearchPromotionsRequest | | | SearchPromotionsRequestPage | | | AddCustomerRelationRequest | | | AddProductsToWishlistRequest | | | WishlistProducts | | | ApproveCustomerFileRequest | | | CaptureGiftCertificateRequest | | | DeleteProductsFromWishlistRequest | | | DeleteWishlistRequest | | | GetCustomerFileRequest | | | GetGiftCertificateBalanceRequest | | | GetQueueCustomersRequest | | | GetQueueCustomersRequestLockSpan | | | LockSpanValue3 | | | GetQueueCustomersRequestPage | | | GetStatusModerationCustomerMarketplaceRequest | | | GetStatusModerationCustomerMarketplaceRequestPage | | | RejectCustomerFileRequest | | | RunCustomerTransitionRequest | | | SaveCompanyRequest | | | SaveCompanyRequestContact | | | SaveCompanyRequestAddresses | | | AddressesExtendedProperties1 | | | ExtendedPropertiesHtmlAttributes1 | | | SaveCompanyRequestExtendedProperties | | | SaveCustomerRequest | | | SaveCustomerRequestContact | | | SaveCustomerRequestAddresses | | | AddressesExtendedProperties2 | | | ExtendedPropertiesHtmlAttributes2 | | | SaveCustomerRequestExtendedProperties | | | SaveCustomerAddressRequest | | | SaveCustomerAddressRequestExtendedProperties | | | ExtendedPropertiesHtmlAttributes3 | | | SaveCustomerFileRequest | | | File | | | SaveCustomerStatusRequest | | | SaveGiftCertificateRequest | | | SaveWishlistRequest | | | SaveWishlistRequestExtendedProperties | | | SearchCustomerRequest | | | SearchCustomerRequestPage | | | SearchGiftCertificateRequest | | | SearchGiftCertificateRequestPage | | | SearchWishlistRequest | | | SearchWishlistRequestPage | | | SearchWishlistShortRequest | | | ShareWishlistRequest | | | GetAllLocationSellerWebSiteRequest | | | Geolocation | | | GetLocationSellerRequest | | | MashupGetCategoryGetCategoryRequest | | | GetProductDataSourceMarketplaceListRequest | | | GetProductDataSourceMarketplaceListRequestPage | | | UpdateFulfillmentRequest | | | Invoice | | | Shipment | | | Volumes | | | PackageInfo | | | Items | | | SearchFulfillmentsRequest | | | SearchFulfillmentsRequestPage | |