Skip to content

Latest commit

 

History

History
332 lines (237 loc) · 11 KB

ProductsApi.md

File metadata and controls

332 lines (237 loc) · 11 KB
Raw

AliseeksApi.ProductsApi

All URIs are relative to https://api.aliseeks.com/v1

Method HTTP request Description
getProduct POST /products Get products details as an aggregated request from AliExpress in realtime.
getProductDetails POST /products/details Gets product details from AliExpress in realtime.
getProductHtmlDescription POST /products/description/html Get product HTML description from AliExpress in realtime.
getProductReviews POST /products/reviews Get product reviews from AliExpress in realtime
getProductShipping POST /products/shipping Gets product shipping information AliExpress in realtime.
getProductSkus POST /products/variations Gets product skus / variation information from AliExpress in realtime.
getProductTransactions POST /products/transactions Get product transactions from AliExpress in realtime.

getProduct

Product getProduct(opts)

Get products details as an aggregated request from AliExpress in realtime.

Example

var AliseeksApi = require('aliseeks-api');
var defaultClient = AliseeksApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

var apiInstance = new AliseeksApi.ProductsApi();
var opts = {
  'productRequest': new AliseeksApi.ProductRequest() // ProductRequest | The request body of get product 
};
apiInstance.getProduct(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
productRequest ProductRequest The request body of get product [optional]

Return type

Product

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getProductDetails

ProductDetail getProductDetails(productDetailsRequest)

Gets product details from AliExpress in realtime.

Example

var AliseeksApi = require('aliseeks-api');
var defaultClient = AliseeksApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

var apiInstance = new AliseeksApi.ProductsApi();
var productDetailsRequest = new AliseeksApi.ProductDetailsRequest(); // ProductDetailsRequest | The request body to get product details 
apiInstance.getProductDetails(productDetailsRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
productDetailsRequest ProductDetailsRequest The request body to get product details

Return type

ProductDetail

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getProductHtmlDescription

ProductHtmlDescription getProductHtmlDescription(productHtmlDescriptionRequest)

Get product HTML description from AliExpress in realtime.

Example

var AliseeksApi = require('aliseeks-api');
var defaultClient = AliseeksApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

var apiInstance = new AliseeksApi.ProductsApi();
var productHtmlDescriptionRequest = new AliseeksApi.ProductHtmlDescriptionRequest(); // ProductHtmlDescriptionRequest | The request body to get product html description 
apiInstance.getProductHtmlDescription(productHtmlDescriptionRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
productHtmlDescriptionRequest ProductHtmlDescriptionRequest The request body to get product html description

Return type

ProductHtmlDescription

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getProductReviews

ProductReviews getProductReviews(productReviewsRequest)

Get product reviews from AliExpress in realtime

Example

var AliseeksApi = require('aliseeks-api');
var defaultClient = AliseeksApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

var apiInstance = new AliseeksApi.ProductsApi();
var productReviewsRequest = new AliseeksApi.ProductReviewsRequest(); // ProductReviewsRequest | The request body to get product reviews 
apiInstance.getProductReviews(productReviewsRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
productReviewsRequest ProductReviewsRequest The request body to get product reviews

Return type

ProductReviews

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getProductShipping

ProductShipping getProductShipping(productShippingRequest)

Gets product shipping information AliExpress in realtime.

Example

var AliseeksApi = require('aliseeks-api');
var defaultClient = AliseeksApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

var apiInstance = new AliseeksApi.ProductsApi();
var productShippingRequest = new AliseeksApi.ProductShippingRequest(); // ProductShippingRequest | The request body to get product shipping 
apiInstance.getProductShipping(productShippingRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
productShippingRequest ProductShippingRequest The request body to get product shipping

Return type

ProductShipping

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getProductSkus

ProductSkus getProductSkus(productSkusRequest)

Gets product skus / variation information from AliExpress in realtime.

Example

var AliseeksApi = require('aliseeks-api');
var defaultClient = AliseeksApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

var apiInstance = new AliseeksApi.ProductsApi();
var productSkusRequest = new AliseeksApi.ProductSkusRequest(); // ProductSkusRequest | The request body to get product skus / variations 
apiInstance.getProductSkus(productSkusRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
productSkusRequest ProductSkusRequest The request body to get product skus / variations

Return type

ProductSkus

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getProductTransactions

ProductTransactions getProductTransactions(productTransactionsRequest)

Get product transactions from AliExpress in realtime.

Example

var AliseeksApi = require('aliseeks-api');
var defaultClient = AliseeksApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

var apiInstance = new AliseeksApi.ProductsApi();
var productTransactionsRequest = new AliseeksApi.ProductTransactionsRequest(); // ProductTransactionsRequest | The request body to get product transactions 
apiInstance.getProductTransactions(productTransactionsRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
productTransactionsRequest ProductTransactionsRequest The request body to get product transactions

Return type

ProductTransactions

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json