@plasma-platform/service-support
v0.0.7
Published
Support service api
Downloads
10
Readme
Full documentation
install:
npm i @plasma-platform/service-support -S
Short documentation
Table of Contents
SupportService
Support Micro Service API
Parameters
getHeaders
Get response headers
Parameters
response
{Object} response data
Returns Object
getSupportByOrderId
Support - Get support by id + orderId
Parameters
params
{Object} request parametersparams.supportId
{Number} support idparams.orderId
{String} order idparams.locale
{String} locale. default: 'en'params.checkAvailability
{Number} Check availability paid support. default: 1
Returns Promise<any>
getSupportById
Support - Get support by id
Parameters
params
{Object} request parametersparams.supportId
{Number} support idparams.locale
{String} locale. default: 'en'params.checkAvailability
{Number} Check availability paid support. default: 1
Returns Promise<any>
searchPaidSupportByPayments
Support - Search paid support by payments
Parameters
params
{Object} request parametersparams.productType
{String} Product typeparams.productIds
{String} Array of product id divided by comma (e.g. "55555,62222")params.ordersIds
{String} Array of order id divided by comma (e.g. "xxx1,az22")params.productTypes
{String} Array of product type divided by comma (e.g. "template,offer"), default: templateparams.locale
{String} 2 char locale (en, ru de, etc.). default: enparams.perPage
{Number} Max items per one page (50 is max size)params.page
{Number} Page number to view
Returns Promise<any>
searchPaidSupportByProduct
Support - Search paid supports by product
Parameters
params
{Object} request parametersparams.locale
{String} 2 char locale (en, ru de, etc.). default: enparams.productIds
{String} Array of product id divided by comma (e.g. "55555,62222")params.ids
{String} Array of support ids divided by comma (e.g. "2530,2531")params.productTypes
{String} Array of product type divided by comma (e.g. "template,offer"), default: templateparams.perPage
{Number} Max items per one page (50 is max size)params.page
{Number} Page number to viewparams.checkAvailability
{Number} Check availability paid support. default: 1
Returns Promise<any>