Package net.pricefx.formulaengine.scripting.queryapi.tables

Interface QapiProductCompetition

All Superinterfaces:
Map<String,SelectableExpression>, PersistedObjectColumns, Tables.Columns, Tables.Table
public interface QapiProductCompetition extends Tables.Table, PersistedObjectColumns
Table of the Competition Data. Each row is one price of a competitor for one of your products: which competitor, where, when and from which source.

Example, the competitor prices of one product: 


 def q = api.queryApi()
 def pc = q.tables().productCompetitions()

 return q.source(pc, [pc.competitor(), pc.price(), pc.currency(), pc.infoDate(), pc.priority()],
         pc.sku().equal("MB-0001"))
         .stream { it.collect { it } }
Since:
15.2.2 - Southside
See Also:

  • Method Details

    • sku

      SelectableExpression sku()
      Returns the Stock Keeping Unit (SKU) of your product that the competitor price is for.
      Returns:
      the sku column as a String expression
      See Also:

    • competitorSku

      SelectableExpression competitorSku()
      Returns the identifier of the competitor's product.
      Returns:
      the competitorSku column as a String expression
      See Also:

    • competitor

      SelectableExpression competitor()
      Returns the name of the competitor.
      Returns:
      the competitor column as a String expression

    • label

      SelectableExpression label()
      Returns the label of the record.
      Returns:
      the label column as a String expression

    • price

      SelectableExpression price()
      Returns the price of the competitor.
      Returns:
      the price column as a Real expression
      See Also:

    • priceType

      SelectableExpression priceType()
      Returns the type of the competitor price.
      Returns:
      the priceType column as a String expression

    • priceUnit

      SelectableExpression priceUnit()
      Returns the price unit of the competitor price.
      Returns:
      the priceUnit column as a Real expression
      See Also:

    • unitOfMeasure

      SelectableExpression unitOfMeasure()
      Returns the unit of measure of the competitor price.
      Returns:
      the unitOfMeasure column as a String expression
      See Also:

    • currency

      SelectableExpression currency()
      Returns the currency of the competitor price.
      Returns:
      the currency column as a String expression
      See Also:

    • competitionType

      SelectableExpression competitionType()
      Returns the type of the competition.
      Returns:
      the competitionType column as a String expression

    • source

      SelectableExpression source()
      Returns the source from which the record was retrieved.
      Returns:
      the source column as a String expression
      See Also:

    • country

      SelectableExpression country()
      Returns the country where the competitor price was obtained.
      Returns:
      the country column as a String expression

    • infoDate

      SelectableExpression infoDate()
      Returns the date and time when the competitor price was obtained.
      Returns:
      the infoDate column as a DateTime expression

    • priority

      SelectableExpression priority()
      Returns the priority of the record. When there are several competitor prices, the priority controls which one is used.
      Returns:
      the priority column as an Integer expression

    • comments

      SelectableExpression comments()
      Returns the comments on the record.
      Returns:
      the comments column as a String expression

    • additionalInfo1

      SelectableExpression additionalInfo1()
      Returns the first additional numeric information of the record.
      Returns:
      the additionalInfo1 column as a Real expression

    • additionalInfo2

      SelectableExpression additionalInfo2()
      Returns the second additional numeric information of the record.
      Returns:
      the additionalInfo2 column as a Real expression

    • additionalInfo3

      SelectableExpression additionalInfo3()
      Returns the first additional text information of the record.
      Returns:
      the additionalInfo3 column as a String expression

    • additionalInfo4

      SelectableExpression additionalInfo4()
      Returns the second additional text information of the record.
      Returns:
      the additionalInfo4 column as a String expression

    • priceAPIRecord

      SelectableExpression priceAPIRecord()
      Returns the content of the priceAPIRecord field of the record, stored as text.
      Returns:
      the priceAPIRecord column as a String expression
      See Also:

    • integrationToken

      SelectableExpression integrationToken()
      Returns the key that identifies the integration the record comes from. Records entered manually have no value.
      Returns:
      the integrationToken column as a String expression
      See Also: