Documentation

Ucommerce includes full API reference documentation and lots of helpful articles to help you build your e-commerce site as effortlessly as possible.

Topics Payment Providers
v7.18

Catalog Library

The catalog Library is a friendly way of allowing you to grab the information you need in order to display catalog items in your webshop. You can either ask for something explicitly or you can have it resolve the data on it's own by leaving the optional parameters alone.

The Catalog library can be accessed under the following namespace:

    using Ucommerce.Api;

To resolve it use the following method or constructor inject the interface directly in your controller or web API route (requires you manually bridge the IOC with the MVC framework):

    
    var catalogLibrary = Ucommerce.Infrastructure.ObjectFactory.Instance.Resolve<Ucommerce.Api.ICatalogLibrary>();
    
    

Ucommerce.Api.ICatalogLibrary

Methods


GetCatalog

  • Arguments
    • Guid? catalogId = null
  • Return type Ucommerce.Search.Models.ProductCatalog

GetRootCategories

  • Arguments
    • Guid? catalogId = null
    • uint skip = 0
    • uint take = 300
  • Return type Ucommerce.Search.ResultSet<Ucommerce.Search.Models.Category>

GetCategory

  • Arguments
    • Guid? categoryId = null
  • Return type Ucommerce.Search.Models.Category

GetCategories

  • Arguments
    • IList<Guid> categoryIds
    • uint skip = 0
    • uint take = 300
  • Return type Ucommerce.Search.ResultSet<Ucommerce.Search.Models.Category>

GetProducts

  • Arguments
    • Guid? categoryId = null
    • uint skip = 0
    • uint take = 300
  • Return type Ucommerce.Search.ResultSet<Ucommerce.Search.Models.Product>

GetProduct

  • Arguments
    • string sku
  • Return type Ucommerce.Search.Models.Product

CalculatePrices

  • Arguments
    • IList<Guid> productGuids
    • IList<Guid> priceGroupGuids = null
  • Return type Ucommerce.Catalog.Models.ProductPriceCalculationResult

ChangePriceGroup

  • Arguments
    • Guid priceGroupGuid
    • Boolean changeBasketBillingCurrency = True
  • Return type Void

GetVariants

  • Arguments
    • Ucommerce.Search.Models.Product product
  • Return type Ucommerce.Search.ResultSet<Ucommerce.Search.Models.Product>

GetProducts

  • Arguments
    • IList<Guid> categoryIds
    • Ucommerce.Search.Facets.FacetDictionary facets
    • uint skip = 0
    • uint take = 300
  • Return type Ucommerce.Search.Facets.FacetResultSet<Ucommerce.Search.Models.Product>

GetProducts

  • Arguments
    • Guid categoryId
    • Ucommerce.Search.Facets.FacetDictionary facets
    • uint skip = 0
    • uint take = 300
  • Return type Ucommerce.Search.Facets.FacetResultSet<Ucommerce.Search.Models.Product>

GetFacets

  • Arguments
    • Guid categoryId
    • Ucommerce.Search.Facets.FacetDictionary facets
    • uint skip = 0
    • uint take = 300
  • Return type IList<Ucommerce.Search.Facets.Facet>

GetFacets

  • Arguments
    • IList<Guid> categoryIds
    • Ucommerce.Search.Facets.FacetDictionary facets
    • uint skip = 0
    • uint take = 300
  • Return type IList<Ucommerce.Search.Facets.Facet>