merchant_store_api

MerchantStoreApi - JavaScript client for merchant_store_api No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.2.2
• Package version: 0.2.2
• Generator version: 7.13.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install merchant_store_api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your merchant_store_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var MerchantStoreApi = require('merchant_store_api');

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

var api = new MerchantStoreApi.DefaultApi()
api.healthCheckV1HealthGet().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to /merchant

Class	Method	HTTP request	Description
MerchantStoreApi.DefaultApi	healthCheckV1HealthGet	GET /v1/health	Health Check
MerchantStoreApi.DefaultApi	publicProbeV1PublicProbeGet	GET /v1/public-probe	Public Probe
MerchantStoreApi.FaqApi	checkIfFAQCollectionExistsV1FaqsCollectionExistsGet	GET /v1/faqs/collection-exists	Check If Faq Collection Exists.
MerchantStoreApi.FaqApi	createFAQByQuestionV1FaqsQuestionPost	POST /v1/faqs/{question}	Create Faq By Question
MerchantStoreApi.FaqApi	createFAQCollectionV1FaqsCollectionPost	POST /v1/faqs/collection	Create Faq Collection
MerchantStoreApi.FaqApi	deleteFAQByInternalIdV1FaqsByInternalIdInternalIdDelete	DELETE /v1/faqs/by-internal-id/{internal_id}	Delete Faq By Internal Id
MerchantStoreApi.FaqApi	deleteFAQByQuestionV1FaqsQuestionDelete	DELETE /v1/faqs/{question}	Delete Faq By Question
MerchantStoreApi.FaqApi	deleteFAQCollectionV1FaqsCollectionDelete	DELETE /v1/faqs/collection	Delete Faq Collection
MerchantStoreApi.FaqApi	deletesAllFAQFromCollectionV1FaqsResetCollectionDelete	DELETE /v1/faqs/reset-collection	Deletes All Faq From Collection
MerchantStoreApi.FaqApi	getAllFAQsV1FaqsGet	GET /v1/faqs	Get All Faqs
MerchantStoreApi.FaqApi	getFAQByQuestionV1FaqsQuestionGet	GET /v1/faqs/{question}	Get Faq By Question
MerchantStoreApi.FaqApi	importMultipleFAQsV1FaqsPost	POST /v1/faqs	Import Multiple Faqs
MerchantStoreApi.FaqApi	updateFAQByQuestionV1FaqsQuestionPut	PUT /v1/faqs/{question}	Update Faq By Question
MerchantStoreApi.ProductApi	checkIfProductCollectionExistsV1ProductsCollectionExistsGet	GET /v1/products/collection-exists	Check If Product Collection Exists.
MerchantStoreApi.ProductApi	createProductBySKUV1ProductsSkuPost	POST /v1/products/{sku}	Create Product By Sku
MerchantStoreApi.ProductApi	createProductCollectionV1ProductsCollectionPost	POST /v1/products/collection	Create Product Collection
MerchantStoreApi.ProductApi	deleteProductByInternalIdV1ProductsByInternalIdInternalIdDelete	DELETE /v1/products/by-internal-id/{internal_id}	Delete Product By Internal Id
MerchantStoreApi.ProductApi	deleteProductByItemGroupId	DELETE /v1/products/item-group/{item_group_id}	Delete Product By Item Group Id
MerchantStoreApi.ProductApi	deleteProductBySKUV1ProductsSkuDelete	DELETE /v1/products/{sku}	Delete Product By Sku
MerchantStoreApi.ProductApi	deleteProductCollectionV1ProductsCollectionDelete	DELETE /v1/products/collection	Delete Product Collection
MerchantStoreApi.ProductApi	deletesAllProductsFromCollectionV1ProductsResetCollectionDelete	DELETE /v1/products/reset-collection	Deletes All Products From Collection
MerchantStoreApi.ProductApi	getAllProductsV1ProductsGet	GET /v1/products	Get All Products
MerchantStoreApi.ProductApi	getProductBySKUV1ProductsSkuGet	GET /v1/products/{sku}	Get Product By Sku
MerchantStoreApi.ProductApi	importMultipleProductsV1ProductsPost	POST /v1/products	Import Multiple Products
MerchantStoreApi.ProductApi	updateProductBySKUV1ProductsSkuPut	PUT /v1/products/{sku}	Update Product By Sku

Documentation for Models

• MerchantStoreApi.Faq
• MerchantStoreApi.HTTPValidationError
• MerchantStoreApi.Product
• MerchantStoreApi.ProductAvailability
• MerchantStoreApi.ValidationError
• MerchantStoreApi.ValidationErrorLocInner

Documentation for Authorization

Authentication schemes defined for the API:

APIKeyHeader

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header