@tcmintrade/api v1.1.13

@tcmintrade/api

Contents

• Install
• Usage
• API
  • TCM Api
  • Extraction
  • Product
• Response Object

Install

Install with npm:

$ npm install --save @tcmintrade/api

Usage

const TCMApi = require("@tcmintrade/api");
const { Extraction, Product } = require("@tcmintrade/api")
const TCM_API = new TCMApi('https://yourendpoint.com')

const extraction = await TCM_API.Extraction.AddExctraction({ ...data })
await TCM_API.Extraction.AddProductSales({ id: extraction.id, data })

API

TCMApi

• new — Create new instance of TCMApi Parameters
  • { String } endpoint ‐ API Base URL

• createRequest — Creates new axios instance based on your endpoint
  Returns

  • { AxiosInstance } — Axios instance

• setEndpoint — set request base URL

Extraction

Extraction is created internally by TCMApi class
all methods returns Response Object

• new — Creates new instance of Extraction Parameters

  • { AxiosRequest } request ‐ Axios instance

• AddExtraction — Add new extraction log
  Parameters

  • { Object } data — Extraction data

• AddBrandMetrics — Add new brand metrics
  Parameters

  • { Object } data — Brand Metrics data

• AddProductKPI — Add new product KPI
  Parameters

  • { Object } data — Product KPI data

• AddBusinessReport — Add business report
  Parameters

  • { String|Number } id — Extraction log id
  • { Object } data — business report data
  • { ?Object } query — business report query

• GetBusinessReportDates — Get business reports dates
  Parameters

  • { ?Object } query — business report dates query

• AddAccountStatus — Add account status
  Parameters

  • { String|Number } id — Extraction log id
  • { Object } data — account status data

• AddProductSKU — Add product SKU
  Parameters

  • { String|Number } id — Product SKU id
  • { Object } data — product sku data

• AddProductSales — Add product sales
  Parameters

  • { String|Number } id — Product SKU id
  • { Object } data — product sales data

• AddProductPricing — Add product pricing
  Parameters

  • { String|Number } id — Product SKU id
  • { Object } data — product pricing data

• AddProductInformation — Add product dnformation
  Parameters

  • { String|Number } id — Product SKU id
  • { Object } data — product information data

• AddProductInventory — Add product inventory
  Parameters

  • { String|Number } id — Product SKU id
  • { Object } data — product inventory data

Product

Product is created internally by TCMApi class
all methods returns Response Object

• AddProduct — Add product
  Parameters

  • { Object } data — product data

• UpdateProduct — Update product
  Parameters

  • { String|Number } productId — product unique id
  • { Object } data — product data

• AllProducts — Get all products
  Parameters

  • { String } merchantId — Store merchant Id
  • { String } marketplaceId — Store marketplace Id

• AddProductDetails — Add Product details
  Parameters

  • { Object } data — product details data

• GetProductDetails — Get product detail
  Parameters

  • { String|Number } productId — product unique id

Response Object

{
  "success": "Boolean",
  "data": "any",
  "status": "String"
}