Class: module:api/ExportApi

module:api/ExportApi(apiClient)

new module:api/ExportApi(apiClient)

Constructs a new ExportApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use, default to module:ApiClient#instance if unspecified.
Source:

Methods

exportProducts(opts) → {Promise}

ExportProducts Used for product export. Depending on the timestamp parameter, it can return all products or only products modified after the given time. Security: Allowed only for trusted client

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
catalog String

Catalog from which get products. Must be provided along with version.
pageSize String

The number of results returned per page.
fields String

Response configuration (list of fields, which should be returned in response)
currentPage String

The current result page requested.
version String

Catalog version. Must be provided along with catalog.
timestamp String

When this parameter is set, only products modified after given time will be returned.This parameter should be in RFC-8601 format.
Source:
Returns:

a Promise">www.promisejs.org/|Promise}, with data of type module:models/ProductList

Type
Promise

exportProductsWithHttpInfo(opts) → {Promise}

ExportProducts Used for product export. Depending on the timestamp parameter, it can return all products or only products modified after the given time. Security: Allowed only for trusted client

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
catalog String

Catalog from which get products. Must be provided along with version.
pageSize String

The number of results returned per page.
fields String

Response configuration (list of fields, which should be returned in response)
currentPage String

The current result page requested.
version String

Catalog version. Must be provided along with catalog.
timestamp String

When this parameter is set, only products modified after given time will be returned.This parameter should be in RFC-8601 format.
Source:
Returns:

a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/ProductList and HTTP response

Type
Promise