Skip to main content

Search

How to get search capabilities in Hii Retail

Hii Retail provides APIs for both input and query use-cases. If you require the ability to search for your own data, and this is not permitted by your current ERP or master data management system, we can provide this.

You need to integrate all the entities you require search capabilities for as input to Hii Retail, and we will make sure they are available for search using our query APIs. The query APIs are build using GraphQL, and this allows you great flexibility in your search options.

If you need to limit the extent of the data returned to your service, this is built into the GraphQL language. You as a consumer of the API can specify which properties of the data to return, and hence limiting the amount of data transferred.

See more details about Hii Retail query APIs here.

Example: Search for Items by Item Identifier​

To search for Items by its barcode, or Item Identifiers, you need to use the Master Data Search API.

Here is an example query to get the Item Id, Item Name, Item Created Date and a list of Price Specifications belonging to that Item:

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 only available if your tenant utilizes 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​

We have a query API for master data search, and individual APIs for each entity type: