Skip to main content

Search

Search Capabilities in Hii Retail

Hii Retail provides APIs for both input and query use cases. If your ERP or master data system does not support search, Hii Retail can provide this functionality.

To enable search, integrate all relevant entities as input to Hii Retail. The data will then be available for search via our query APIs, which use GraphQL for flexible queries.

You can limit the data returned by specifying which properties to include in your GraphQL query.

See more about Hii Retail query APIs here.

Example: Search for Items by Item Identifier​

To search for Items by barcode or Item Identifier, use the Master Data Search API.

Example query to get Item Id, Name, Created Date, and Price Specifications:

query {
  itemIdentifier(gtin:"7622201823085", businessUnitGroupId: "987654"){
    value
    itemId
    item {
      entityMetadata {
        id
        name
        created
      }
      priceSpecifications {
        nodes {
          value
          itemId
          priceType
          validFrom
          validTo
          minPrice
          maxPrice
        }
      }
    }
  }
}

Example: Search using Complete Item Query API​

The Complete Item Query API is available if your tenant uses the Complete Items feature.

query completeItems {
  completeItems(
    first: 10
    searchTerm: "name: \"paper\""
    filter: {
      assortmentPolicyType: IN_ASSORTMENT
      businessUnitId: "STORE_A"
      status: ACTIVE
    }
  ) {
    nodes {
      assortmentPolicyType
      brand
      correlationId
      createdBy
      description
      id
      images {
        heightInPixels
        intendedAudience
        modified
        size
        url
        widthInPixels
      }
      itemCategoryId
      itemIdentifiers {
        type
        value
        isPrimary
      }
      modifiedBy
      name
      netContent
      priceSpecifications {
        isCurrent
        isMandatory
        maxPrice
        minPrice
        modifiedBy
        promotionId
        taxableGroupId
        type
        value
      }
      additionalProperties {
        dataType
        name
        value
      }
    }
  }
}

API Reference​

Hii Retail provides a query API for master data search and individual APIs for each entity type: