Purchase Page

rrContext
 

• apiClientKey
• apiKey
• sessionId
• user
  • userid
  • userAttributes 
    Items: UserAttribute
    • attributeName
    • attributeValue
  • segments

• userAgent

required (object)
 

• required (string)
• required (string)
• (string)
• (object)
  • (string)
  • (array of UserAttributes)
     
    • required (string)
    • (array of )
  • (array of string)   

• required (string)

The context that can be provided to Rich Relevance to best serve a request.

• The api client assigned for the client specific application.
• The api key of the merchant
• The session id assigned to the request by the merchant.

• All the user specific information that can be provided for the request

  • The merchant defined identifier for the user

  • The attributes of the user that merchant can provide

    • The name of the user attribute
    • The value of the user attribute
  • All the segments a user might belong to
• The user agent string making the request

localizationContext

• region
   
• language
   
• currency

(object)

• (string)
   
• (string)
   
• (string)

The localization context of the request.

• The merchant defined region from which the request originated. It must match the regions provided in the feed by the merchant.
• The merchant defined language code of the request. It must match the language codes in the feed provided by the merchant.
• The currency code for the request. It mush match the currency codes in the feed provided by the merchant.

purchaseOrders
Items: PurchaseOrder

• orderId
• productLineItems
  Items: ProductLineItem
  • productId
  • quantity
  • priceCents
  • sku
• orderChannel
• emailHash
• cardHash
• storeId

required (array of PurchaseOrder)

• (string)
• required (array of ProductLineItem)
   
  • required (string)
  • required (integer)
  • required (integer)
  • (string)
• (string)
• (string)
• (string)
• (string)

The information about the products purchased.
 

• The purchase order number
• The product(s) purchased in the order.
  
   
  • The product that was purchased.
  • The number of units that were purchased.
  • The price of the product that was purchased.
  • The identifier of the SKU that was purchased if any
• The retail channel through which the product was purchased
• The hash of the email address of the user
• The hash of the credit card used for purchase.
• The store in which the purchase was made.

mvt
Items: MVTTreatment

• testId
• treatmentId: 
• treatmentName
• control

(array of MVTTreatment)
 

•  required (number)
• required (string)
• required (string)
• required (boolean)

The MVT specific information for the request.
 

• The test identifier for MVT.
• The treatment identifier for MVT.
• The name of the treatment.
• Was the MVT part of the control.

responsePlacements
Items: ResponsePlacement

• placementName
• strategyMessage
   
• strategyName
   
• recommendedProducts
  Items: RecommendedProduct
  • productId
  • productName
  • productURL
  • imageURL
  • price
  • priceRange
    • minSalesPrice
    • maxSalesPrice
• brand
• categories

  Items: ProductCategories

  • categoryId
  • categoryName
• productAttributes: ProductAttributes
  • attributeName
  • attributeValue
• ratings
• reviews
• clickTrackingURL

unFulfilledPlacements
Items: UnFulfilledPlacement

• placementName
   
• reason

required (array of ResponsePlacement)

• required (string)
• required (string)
   
• required (string)
   
• required (array of RecommendedProduct)
  • required (string)
  • required (string)
  • required (string)
  • required (string)
  • required (integer)
  • required (object)
    • required (integer)
    • required (integer)
• required (string)
• required (string)
  
   
  • required (string)
  • required (string)
• ​​​​​​required (array of ProductAttributes)
  • ​​​​​​​required (string)
  • required (array of )
•  required (number)
• required (integer)
• required (string)

​​​​​​​required (array of UnFulfilledPlacement)

• required (string)
   
• required (string)

The recommendations for each placement fulfilled by the service for the request.

• The placement name for which the recommendation are returned.
• The message attached to the strategy whose recommendations are being returned.
• The name of the strategy whose recommendations are being returned.
• The most relevant information of the products that are being recommended for the placement.
  • The unique identifier of the product being recommended.
  • The name of the product being recommended.
  • The link on the merchant's website for the product.
  • The location to the image of the product.
  • The price of the product in cents.
     
    • The minimum sales price of the product in cents.
    • The maximum sales price of the product in cents.
  • The brand of the product.
  • The categories to which a product belongs.
    
    ​​​​​​​
  • The identifier for a merchant's category.
  • The name of the category.
• All the product attributes.
  ​​​​​​​
  • The name of the product attribute.
  • The value associated with the attribute name.
• The ratings that the product has received.
• The number of reviews that the product has received.
• The URL to track a click on the product by a Rich Relevance service.

The placements for which the recommendations are not being generated.

• The name of the placement for which the recommendations are not returned
• The reason why the recommendations were not returned for the placement.