All URIs are relative to https://mgmtapi.geins.io
| Method | HTTP request | Description |
|---|---|---|
| addAvailabilityMonitor | POST /API/Product/MonitorAvailability | Add a product availability monitor |
| addCategoryToProduct | PUT /API/Product/{productId}/Category | Adds a category relation to a product |
| addImageToProduct | PUT /API/Product/{productId}/Image/{imageName} | Adds an image relation to a product |
| addRelatedProductsToProduct | PUT /API/Product/{productId}/Related | Add related products to a product |
| batchUpdateProductItems | PUT /API/Product/Items | Updates product items in batch |
| batchUpdateStockValues | PUT /API/Product/Stock | Update stock values for multiple product items |
| createProduct | POST /API/Product | Create a new product |
| createProductItems | POST /API/Product/{productId}/Item | Create a new product item |
| getProductById | GET /API/Product/{productId} | Get a specific product |
| getProductItemById | GET /API/Product/Item/{itemId} | Get a specific product item |
| linkRelatedProductsByRelationId | PUT /API/Product/{productId}/Related/{relationTypeId} | Add related products to a product using a fixed relation type |
| listAllProductItemsPaged | GET /API/Product/Items/{page} | Get all product items with pagination |
| listFeeds | GET /API/Product/Feeds | Gets a list of all feeds |
| listProductItems | GET /API/Product/Items | Get all product items |
| listProductRelationTypes | GET /API/Product/RelationTypes | Gets a list of product relation types |
| queryProducts | POST /API/Product/Query | Query products |
| queryProductsPaged | POST /API/Product/Query/{page} | Query products with pagination |
| queryStock | POST /API/Product/Stock/Query | Query stock |
| updateProduct | PUT /API/Product/{productId} | Updates a product |
| updateProductItem | PUT /API/Product/Item/{itemId} | Updates a product item |
Envelope addAvailabilityMonitor(model)
Add a product availability monitor
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
ProductModelsMonitorSku model = new ProductModelsMonitorSku(); // ProductModelsMonitorSku |
try {
Envelope result = apiInstance.addAvailabilityMonitor(model);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#addAvailabilityMonitor");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| model | ProductModelsMonitorSku |
- Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
- Accept: application/json, text/json, application/xml, text/xml
Envelope addCategoryToProduct(productId, productCategory, productIdType)
Adds a category relation to a product
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
String productId = null; // String | The id of the product to update.
ProductModelsProductCategory productCategory = new ProductModelsProductCategory(); // ProductModelsProductCategory | The category to relate the product to.
Integer productIdType = null; // Integer | The type of product id supplied in {productId}.
try {
Envelope result = apiInstance.addCategoryToProduct(productId, productCategory, productIdType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#addCategoryToProduct");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| productId | String | The id of the product to update. | [default to null] |
| productCategory | ProductModelsProductCategory | The category to relate the product to. | |
| productIdType | Integer | The type of product id supplied in {productId}. | [optional] [default to null] [enum: 0, 1, 2, 3] |
- Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
- Accept: application/json, text/json, application/xml, text/xml
Envelope addImageToProduct(productId, imageName, isPrimaryImage, productIdType)
Adds an image relation to a product
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
String productId = null; // String | The id of the product to update.
String imageName = null; // String | The name of the image to set to product.
Boolean isPrimaryImage = null; // Boolean | Specifies whether {imageName} should be set as the primary image of the product.
Integer productIdType = null; // Integer | The type of product id supplied in {productId}.
try {
Envelope result = apiInstance.addImageToProduct(productId, imageName, isPrimaryImage, productIdType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#addImageToProduct");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| productId | String | The id of the product to update. | [default to null] |
| imageName | String | The name of the image to set to product. | [default to null] |
| isPrimaryImage | Boolean | Specifies whether {imageName} should be set as the primary image of the product. | [optional] [default to null] |
| productIdType | Integer | The type of product id supplied in {productId}. | [optional] [default to null] [enum: 0, 1, 2, 3] |
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml
ProductModelsRelatedProductEnvelope addRelatedProductsToProduct(productId, relatedProducts, productIdType)
Add related products to a product
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
String productId = null; // String | The id of the main product to which the relations will be created
List<ProductModelsWriteRelatedProduct> relatedProducts = Arrays.asList(new ProductModelsWriteRelatedProduct()); // List<ProductModelsWriteRelatedProduct> | The list of related products to link with the main product.
Integer productIdType = null; // Integer | The type of product id for {productId} and supplied in {relatedProducts}.
try {
ProductModelsRelatedProductEnvelope result = apiInstance.addRelatedProductsToProduct(productId, relatedProducts, productIdType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#addRelatedProductsToProduct");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| productId | String | The id of the main product to which the relations will be created | [default to null] |
| relatedProducts | List<ProductModelsWriteRelatedProduct> | The list of related products to link with the main product. | |
| productIdType | Integer | The type of product id for {productId} and supplied in {relatedProducts}. | [optional] [default to null] [enum: 0, 1, 2, 3] |
ProductModelsRelatedProductEnvelope
- Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
- Accept: application/json, text/json, application/xml, text/xml
Envelope batchUpdateProductItems(productItems, productItemIdType)
Updates product items in batch
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
List<ProductModelsWriteProductItem> productItems = Arrays.asList(new ProductModelsWriteProductItem()); // List<ProductModelsWriteProductItem> | The product items to update
Integer productItemIdType = null; // Integer | The type of product item id
try {
Envelope result = apiInstance.batchUpdateProductItems(productItems, productItemIdType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#batchUpdateProductItems");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| productItems | List<ProductModelsWriteProductItem> | The product items to update | |
| productItemIdType | Integer | The type of product item id | [optional] [default to null] [enum: 0, 1, 2, 3, 4] |
- Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
- Accept: application/json, text/json, application/xml, text/xml
ProductModelsStockEnvelope batchUpdateStockValues(productItemStocks, productItemIdType)
Update stock values for multiple product items
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
List<ProductModelsWriteProductItemStock> productItemStocks = Arrays.asList(new ProductModelsWriteProductItemStock()); // List<ProductModelsWriteProductItemStock> | List of product item ids with new stock values.
Integer productItemIdType = null; // Integer | The type of product item id supplied in {productItemStocks}.
try {
ProductModelsStockEnvelope result = apiInstance.batchUpdateStockValues(productItemStocks, productItemIdType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#batchUpdateStockValues");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| productItemStocks | List<ProductModelsWriteProductItemStock> | List of product item ids with new stock values. | |
| productItemIdType | Integer | The type of product item id supplied in {productItemStocks}. | [optional] [default to null] [enum: 0, 1, 2, 3, 4] |
- Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
- Accept: application/json, text/json, application/xml, text/xml
EnvelopeProductModelsReadProduct createProduct(product, include)
Create a new product
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
ProductModelsWriteProduct product = new ProductModelsWriteProduct(); // ProductModelsWriteProduct | The product to create.
String include = null; // String | Comma separated list of child-collections to also include with the created product. See {Product.Models.ProductIncludes} names for valid options.
try {
EnvelopeProductModelsReadProduct result = apiInstance.createProduct(product, include);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#createProduct");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| product | ProductModelsWriteProduct | The product to create. | |
| include | String | Comma separated list of child-collections to also include with the created product. See {Product.Models.ProductIncludes} names for valid options. | [optional] [default to null] |
EnvelopeProductModelsReadProduct
- Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
- Accept: application/json, text/json, application/xml, text/xml
EnvelopeProductModelsReadProductItem createProductItems(productId, productItem, productIdType)
Create a new product item
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
String productId = null; // String | The id of the product to create an item on.
ProductModelsWriteProductItem productItem = new ProductModelsWriteProductItem(); // ProductModelsWriteProductItem | The product item to create.
Integer productIdType = null; // Integer | The type of product id supplied in {productId}.
try {
EnvelopeProductModelsReadProductItem result = apiInstance.createProductItems(productId, productItem, productIdType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#createProductItems");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| productId | String | The id of the product to create an item on. | [default to null] |
| productItem | ProductModelsWriteProductItem | The product item to create. | |
| productIdType | Integer | The type of product id supplied in {productId}. | [optional] [default to null] [enum: 0, 1, 2, 3] |
EnvelopeProductModelsReadProductItem
- Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
- Accept: application/json, text/json, application/xml, text/xml
EnvelopeProductModelsReadProduct getProductById(productId, productIdType, include)
Get a specific product
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
String productId = null; // String | The id of the product to get.
Integer productIdType = null; // Integer | The type of product id supplied in {productId}.
String include = null; // String | Comma separated list of child-collections to also include with the requested product. See {Product.Models.ProductIncludes} names for valid options.
try {
EnvelopeProductModelsReadProduct result = apiInstance.getProductById(productId, productIdType, include);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#getProductById");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| productId | String | The id of the product to get. | [default to null] |
| productIdType | Integer | The type of product id supplied in {productId}. | [optional] [default to null] [enum: 0, 1, 2, 3] |
| include | String | Comma separated list of child-collections to also include with the requested product. See {Product.Models.ProductIncludes} names for valid options. | [optional] [default to null] |
EnvelopeProductModelsReadProduct
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml
ProductProductItemEnvelope getProductItemById(itemId, productItemIdType)
Get a specific product item
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
String itemId = null; // String | The id of the product item to get.
Integer productItemIdType = null; // Integer | The type of product item id supplied in {itemId}.
try {
ProductProductItemEnvelope result = apiInstance.getProductItemById(itemId, productItemIdType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#getProductItemById");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| itemId | String | The id of the product item to get. | [default to null] |
| productItemIdType | Integer | The type of product item id supplied in {itemId}. | [optional] [default to null] [enum: 0, 1, 2, 3, 4] |
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml
ProductModelsRelatedProductEnvelope linkRelatedProductsByRelationId(productId, relationTypeId, relatedProducts, productIdType)
Add related products to a product using a fixed relation type
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
String productId = null; // String | The id of the main product to which the relations will be created
Integer relationTypeId = null; // Integer | The relation type id that will apply to all related products in {relatedProducts}
List<ProductModelsWriteRelatedProduct> relatedProducts = Arrays.asList(new ProductModelsWriteRelatedProduct()); // List<ProductModelsWriteRelatedProduct> | The list of related products to link with the main product.
Integer productIdType = null; // Integer | The type of product id for {productId} and supplied in {relatedProducts}.
try {
ProductModelsRelatedProductEnvelope result = apiInstance.linkRelatedProductsByRelationId(productId, relationTypeId, relatedProducts, productIdType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#linkRelatedProductsByRelationId");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| productId | String | The id of the main product to which the relations will be created | [default to null] |
| relationTypeId | Integer | The relation type id that will apply to all related products in {relatedProducts} | [default to null] |
| relatedProducts | List<ProductModelsWriteRelatedProduct> | The list of related products to link with the main product. | |
| productIdType | Integer | The type of product id for {productId} and supplied in {relatedProducts}. | [optional] [default to null] [enum: 0, 1, 2, 3] |
ProductModelsRelatedProductEnvelope
- Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
- Accept: application/json, text/json, application/xml, text/xml
EnvelopeListProductModelsReadProductItem listAllProductItemsPaged(page)
Get all product items with pagination
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
Integer page = null; // Integer | The page to fetch
try {
EnvelopeListProductModelsReadProductItem result = apiInstance.listAllProductItemsPaged(page);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#listAllProductItemsPaged");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | The page to fetch | [default to null] |
EnvelopeListProductModelsReadProductItem
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml
EnvelopeListProductModelsReadFeed listFeeds()
Gets a list of all feeds
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
try {
EnvelopeListProductModelsReadFeed result = apiInstance.listFeeds();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#listFeeds");
e.printStackTrace();
}This endpoint does not need any parameter.
EnvelopeListProductModelsReadFeed
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml
List<ProductModelsReadProductItem> listProductItems()
Get all product items
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
try {
List<ProductModelsReadProductItem> result = apiInstance.listProductItems();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#listProductItems");
e.printStackTrace();
}This endpoint does not need any parameter.
List<ProductModelsReadProductItem>
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml
EnvelopeListProductModelsReadRelationType listProductRelationTypes()
Gets a list of product relation types
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
try {
EnvelopeListProductModelsReadRelationType result = apiInstance.listProductRelationTypes();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#listProductRelationTypes");
e.printStackTrace();
}This endpoint does not need any parameter.
EnvelopeListProductModelsReadRelationType
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml
EnvelopeListProductModelsReadProduct queryProducts(query, include)
Query products
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
ProductModelsProductQuery query = new ProductModelsProductQuery(); // ProductModelsProductQuery | The details of the query
String include = null; // String | Comma separated list of child-collections to also include with the queried products. See {Product.Models.ProductIncludes} names for valid options.
try {
EnvelopeListProductModelsReadProduct result = apiInstance.queryProducts(query, include);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#queryProducts");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| query | ProductModelsProductQuery | The details of the query | |
| include | String | Comma separated list of child-collections to also include with the queried products. See {Product.Models.ProductIncludes} names for valid options. | [optional] [default to null] |
EnvelopeListProductModelsReadProduct
- Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
- Accept: application/json, text/json, application/xml, text/xml
EnvelopeListProductModelsReadProduct queryProductsPaged(page, query, include)
Query products with pagination
The {Product.Models.ProductQuery.BatchId} property is mandatory when fetching a page other than the first page. If no BatchId is provided for the first page, a new batch is created and the BatchId can be found in the {Envelope.PageResult} field.
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
Integer page = null; // Integer | The page to fetch. To start a new batched query it is mandatory to send in page=1
ProductModelsProductQuery query = new ProductModelsProductQuery(); // ProductModelsProductQuery | The details of the query
String include = null; // String | Comma separated list of child-collections to also include with the queried products. See {Product.Models.ProductIncludes} names for valid options.
try {
EnvelopeListProductModelsReadProduct result = apiInstance.queryProductsPaged(page, query, include);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#queryProductsPaged");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | The page to fetch. To start a new batched query it is mandatory to send in page=1 | [default to null] |
| query | ProductModelsProductQuery | The details of the query | |
| include | String | Comma separated list of child-collections to also include with the queried products. See {Product.Models.ProductIncludes} names for valid options. | [optional] [default to null] |
EnvelopeListProductModelsReadProduct
- Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
- Accept: application/json, text/json, application/xml, text/xml
List<ProductModelsReadProductItemStock> queryStock(productItemIds)
Query stock
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
List<Integer> productItemIds = Arrays.asList(56); // List<Integer> | The details of the query.
try {
List<ProductModelsReadProductItemStock> result = apiInstance.queryStock(productItemIds);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#queryStock");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| productItemIds | List<Integer> | The details of the query. |
List<ProductModelsReadProductItemStock>
- Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
- Accept: application/json, text/json, application/xml, text/xml
EnvelopeProductModelsReadProduct updateProduct(productId, product, productIdType, include)
Updates a product
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
String productId = null; // String | The id of the product to update.
ProductModelsWriteProduct product = new ProductModelsWriteProduct(); // ProductModelsWriteProduct | The product data to update.
Integer productIdType = null; // Integer | The type of product id supplied in {productId}.
String include = null; // String | Comma separated list of child-collections to also include with the updated product. See {Product.Models.ProductIncludes} names for valid options.
try {
EnvelopeProductModelsReadProduct result = apiInstance.updateProduct(productId, product, productIdType, include);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#updateProduct");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| productId | String | The id of the product to update. | [default to null] |
| product | ProductModelsWriteProduct | The product data to update. | |
| productIdType | Integer | The type of product id supplied in {productId}. | [optional] [default to null] [enum: 0, 1, 2, 3] |
| include | String | Comma separated list of child-collections to also include with the updated product. See {Product.Models.ProductIncludes} names for valid options. | [optional] [default to null] |
EnvelopeProductModelsReadProduct
- Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
- Accept: application/json, text/json, application/xml, text/xml
EnvelopeProductModelsReadProductItem updateProductItem(itemId, productItem, productItemIdType)
Updates a product item
// Import classes:
//import org.openapitools.client.api.ProductApi;
ProductApi apiInstance = new ProductApi();
String itemId = null; // String | The id of the product item to update.
ProductModelsWriteProductItem productItem = new ProductModelsWriteProductItem(); // ProductModelsWriteProductItem | The product item data to update.
Integer productItemIdType = null; // Integer | The type of product item id supplied in {itemId}.
try {
EnvelopeProductModelsReadProductItem result = apiInstance.updateProductItem(itemId, productItem, productItemIdType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductApi#updateProductItem");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| itemId | String | The id of the product item to update. | [default to null] |
| productItem | ProductModelsWriteProductItem | The product item data to update. | |
| productItemIdType | Integer | The type of product item id supplied in {itemId}. | [optional] [default to null] [enum: 0, 1, 2, 3, 4] |
EnvelopeProductModelsReadProductItem
- Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
- Accept: application/json, text/json, application/xml, text/xml