Guides

Retrieval Unique Key

Suggest Edits
Attribute type idType specific restriction parameters
Any attribute type

📘

Retrieval Unique Key is special attribute, used to match retrieved products with products already available in PDX in process of merging of incoming product data.

Can be of any type, as it is used as a matching condition to identify the product pairs on retrieval.

🚧

Only one attribute can be set as a retrieval unique key.

This attribute should be attached to root category so it’s always available

Code Examples:

{
  "id" : "GTIN",
  "name" : "globalTradeItemNumber (GTIN)",
  "type" : {
    "id" : "gtin",
    "restriction" : {
      "parameters" : {
        "gtinSizes" : "[14]"
      }
    }
  }
}

{
  "id" : "PRODUCT_KEY",
  "name" : "Product Key",
  "type" : {
    "id" : "string",
    "restriction" : {
      "parameters" : {
        "minLength" : "4",
        "maxLength" : "120"
      }
    }
  }
}

Attribute retrievalUniqueKeyAttribute = AttributeBuilder.retrievalUniqueKeyAttribute("FAMILY_NAME", "Family Name")
        .withMinLength(4)
        .withMaxLength(120)
        .build();

Updated about 1 year ago