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;
    using Ucommerce.Infrastructure;
    using Ucommerce.Search.Slugs;

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):

Ucommerce.Api.ICatalogLibrary

description

Methods


GetCatalog

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

GetRootCategories

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

GetCategory

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

GetCategories

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

GetProducts

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

GetProduct

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

CalculatePrices

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

ChangePriceGroup

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

GetVariants

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

GetProducts

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

GetProducts

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

GetFacets

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

GetFacets

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