new module:api/ProductsApi(apiClient)
Constructs a new ProductsApi.
Parameters:
Name | Type | Description |
---|---|---|
apiClient |
module:ApiClient | Optional API client implementation to use, default to module:ApiClient#instance if unspecified. |
- Source:
Methods
getProductsByID(id, opts) → {Promise}
To access single products resource, you construct a URL using the template shown below. This template requires you to specify an Id (typically a SKU) for a product. In response, the server returns a corresponding Product document, provided the product is online and assigned to site catalog. The document contains variation attributes (including values) and the variant matrix; this data is provided for both the master and for the variant.
Parameters:
Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
String | The id of the requested product. |
||||||||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with data of type module:models/Product
- Type
- Promise
getProductsByIDAvailability(id, opts) → {Promise}
Access product availability information of products that are online and assigned to site catalog.
Parameters:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
|||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with data of type module:models/Product
- Type
- Promise
getProductsByIDAvailabilityWithHttpInfo(id, opts) → {Promise}
Access product availability information of products that are online and assigned to site catalog.
Parameters:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
|||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with an object containing data of type module:models/Product and HTTP response
- Type
- Promise
getProductsByIDBundledProducts(id, opts) → {Promise}
Access bundled product information of products that are online and assigned to site catalog.
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with data of type module:models/Product
- Type
- Promise
getProductsByIDBundledProductsWithHttpInfo(id, opts) → {Promise}
Access bundled product information of products that are online and assigned to site catalog.
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with an object containing data of type module:models/Product and HTTP response
- Type
- Promise
getProductsByIDImages(id, opts) → {Promise}
Access product image information of products that are online and assigned to site catalog. Filter the result by view type and variation values.
Parameters:
Name | Type | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
|||||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with data of type module:models/Product
- Type
- Promise
getProductsByIDImagesWithHttpInfo(id, opts) → {Promise}
Access product image information of products that are online and assigned to site catalog. Filter the result by view type and variation values.
Parameters:
Name | Type | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
|||||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with an object containing data of type module:models/Product and HTTP response
- Type
- Promise
getProductsByIDLinks(id, opts) → {Promise}
Access product link information of products that are online and assigned to site catalog. Filter the result by link type and link direction.
Parameters:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with data of type module:models/Product
- Type
- Promise
getProductsByIDLinksWithHttpInfo(id, opts) → {Promise}
Access product link information of products that are online and assigned to site catalog. Filter the result by link type and link direction.
Parameters:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with an object containing data of type module:models/Product and HTTP response
- Type
- Promise
getProductsByIDOptions(id, opts) → {Promise}
Access product option information of products that are online and assigned to site catalog.
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with data of type module:models/Product
- Type
- Promise
getProductsByIDOptionsWithHttpInfo(id, opts) → {Promise}
Access product option information of products that are online and assigned to site catalog.
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with an object containing data of type module:models/Product and HTTP response
- Type
- Promise
getProductsByIDPrices(id, opts) → {Promise}
Access product price information of products that are online and assigned to site catalog.
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with data of type module:models/Product
- Type
- Promise
getProductsByIDPricesWithHttpInfo(id, opts) → {Promise}
Access product price information of products that are online and assigned to site catalog.
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with an object containing data of type module:models/Product and HTTP response
- Type
- Promise
getProductsByIDPromotions(id, opts) → {Promise}
Access product promotion information of products that are online and assigned to site catalog.
Parameters:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
|||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with data of type module:models/Product
- Type
- Promise
getProductsByIDPromotionsWithHttpInfo(id, opts) → {Promise}
Access product promotion information of products that are online and assigned to site catalog.
Parameters:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
|||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with an object containing data of type module:models/Product and HTTP response
- Type
- Promise
getProductsByIDRecommendations(id, opts) → {Promise}
Access product recommendation information of products that are online and assigned to site catalog.
Parameters:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
|||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with data of type module:models/Product
- Type
- Promise
getProductsByIDRecommendationsWithHttpInfo(id, opts) → {Promise}
Access product recommendation information of products that are online and assigned to site catalog.
Parameters:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
|||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with an object containing data of type module:models/Product and HTTP response
- Type
- Promise
getProductsByIDs(ids, opts) → {Promise}
Parameters:
Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ids |
Array.<String> | |||||||||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with data of type module:models/ProductResult
- Type
- Promise
getProductsByIDSetProducts(id, opts) → {Promise}
Access product set information of products that are online and assigned to site catalog.
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with data of type module:models/Product
- Type
- Promise
getProductsByIDSetProductsWithHttpInfo(id, opts) → {Promise}
Access product set information of products that are online and assigned to site catalog.
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with an object containing data of type module:models/Product and HTTP response
- Type
- Promise
getProductsByIDShippingMethods(id) → {Promise}
Retrieves the applicable shipping methods for a certain product.
Parameters:
Name | Type | Description |
---|---|---|
id |
String | the requested product id |
- Source:
Returns:
a Promise, with data of type module:models/ShippingMethodResult
- Type
- Promise
getProductsByIDShippingMethodsWithHttpInfo(id) → {Promise}
Retrieves the applicable shipping methods for a certain product.
Parameters:
Name | Type | Description |
---|---|---|
id |
String | the requested product id |
- Source:
Returns:
a Promise, with an object containing data of type module:models/ShippingMethodResult and HTTP response
- Type
- Promise
getProductsByIDsWithHttpInfo(ids, opts) → {Promise}
Parameters:
Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ids |
Array.<String> | |||||||||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with an object containing data of type module:models/ProductResult and HTTP response
- Type
- Promise
getProductsByIDVariations(id, opts) → {Promise}
Access product variation information of products that are online and assigned to site catalog.
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with data of type module:models/Product
- Type
- Promise
getProductsByIDVariationsWithHttpInfo(id, opts) → {Promise}
Access product variation information of products that are online and assigned to site catalog.
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
id |
String | The requested product id. |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with an object containing data of type module:models/Product and HTTP response
- Type
- Promise
getProductsByIDWithHttpInfo(id, opts) → {Promise}
To access single products resource, you construct a URL using the template shown below. This template requires you to specify an Id (typically a SKU) for a product. In response, the server returns a corresponding Product document, provided the product is online and assigned to site catalog. The document contains variation attributes (including values) and the variant matrix; this data is provided for both the master and for the variant.
Parameters:
Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
String | The id of the requested product. |
||||||||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise, with an object containing data of type module:models/Product and HTTP response
- Type
- Promise