NOTE: Trivore ID Documentation has moved to https://trivoreid.com

The content on this site IS OUT OF DATE!

This space has been archived!

Please go ahead to the new site!

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 8 Next »

Wrapper for the '/products' API. Please note that the Sales service might not be present in all servers.

List of all options:

Initialize service

TrivoreID sdk = TrivoreID.mgmtApiClient();
ProductsServiceImpl productsService = new ProductsServiceImpl(sdk.productsService());

Catalog management

// get page with first five catalogs with the ownerId '1234'
Filter filter = Filter.equal("ownedId", "1234");
Page<Catalog> page = productsService.getAllCatalogs(new Criteria(filter, 0, 5));

// create new catalog
Catalog catalog = new Catalog();
catalog.setOwnerId("1234");
catalog.setName("Example Catalog");

// the function returns catalog object with the generated id
catalog = productsService.createCatalog(catalog);

// update catalog
catalog.getCustomFields().put("key1", "value");
catalog.getCustomFields().put("key2", 2);
catalog = productsService.updateCatalog(catalog);

// get catalog
catalog = productsService.getCatalog(catalog.getId());

// delete catalog
productsService.deleteCatalog(catalog.getId());

Pricing plan management

// get page with first five pricing plans that are enabled
Filter filter = Filter.equal("enabled", true);
Page<PricingPlan> page = productsService.getAllPricingPlans(new Criteria(filter, 0, 5));

// create new pricing plan
PricingPlan pricingPlan = new PricingPlan();
pricingPlan.setOwnerId("1234");
pricingPlan.setTitle("Example Title");

// the function returns pricing plan object with the generated id
pricingPlan = productsService.createPricingPlan(pricingPlan);

// update pricing plan
pricingPlan.getCustomFields().put("key1", "value");
pricingPlan.getCustomFields().put("key2", 2);
pricingPlan = productsService.updatePricingPlan(pricingPlan);

// get pricing plan
pricingPlan = productsService.getPricingPlan(pricingPlan.getId());

// delete pricing plan
productsService.deletePricingPlan(pricingPlan.getId());

Product management

// get page with first five products with the ownerId '1234'
Filter filter = Filter.equal("enabled", true);
Page<Product> page = productsService.getAllProducts(new Criteria(filter, 0, 5));

// create new product
Product product = new Product();
product.setOwnerId("1234");
product.setSku("C12");

// the function returns product object with the generated id
product = productsService.createProduct(product);

// update product
product.getCustomFields().put("key1", "value");
product.getCustomFields().put("key2", 2);
product = productsService.updateProduct(product);

// get product
product = productsService.getProduct(product.getId());

// delete product
productsService.deleteProduct(product.getId());

Catalog and Item details

// get all accessible catalogs and their product item details.
AllCatalogs allCatalogs = productService.getAllCatalogsAndItems();

// apply parameters
allCatalogs = productService.getAllCatalogsAndItems("fi", "EUR", null,
					new String[] { "segmentId1", "segmentId2" }, "2020-12-03T10:15:30.00Z");

// get catalog and its product item details
String catalogId = allCatalogs.getCatalogs().get(0).getCatalogId();
CatalogDetails details = productService.getCatalogDetails(catalogId);

// apply parameters
details = productService.getCatalogDetails(catalogId, "en", "GBP", null, null, null, 2, null);

// get product details
String productId = details.getProducts().get(0).getProductId()
ProductDetails productDetails = productService.getProductDetails(catalogId, productId);

// apply parameters
ProductDetails productDetails = productService.getProductDetails(tmpId, tmpId2, "en", null, null,
							new String[] { "discountCode1", "discountCode1" }, null, 5, null);

Service models

Catalog

CatalogItem

LocalisedDescription

PricingPlan

Pricing

CodeDiscount

CustomerSegementDiscount

PaymentMethodDiscount

VariableDiscount

VolumeDiscount

Product

Validity

  • No labels