Search
K
Kroger Ad Platform API

EntitiesRequest

object
baseBidAny Of

The base bid used for all entities that have useBaseBid set to true.

Variant 1number
entitiesarray[object]required

The products to be advertised.

Show Child Parameters
Example

Entity

object
idintegerrequired

Entity id

useBaseBidbooleanrequired

Whether to use base bid.

bidAmountAny Of

Bid amount for this entity.

Variant 1number
deletedbooleanrequired

Whether this entity is deleted.

Example

EntityMeta

object
successbooleanrequired

Whether the entity request was successful.

messageAny Of

Error message if the request was not successful.

Variant 1string
codeAny Of

Error code if the request was not successful.

Variant 1integer
publishStatusAny Of

Publish status of the entity.

PublishStatusstring

Allowed values:EMPTYPENDINGFAILEDPUBLISHED

errorsAny Of

List of errors if the request was not successful.

Variant 1array[object]
warningsAny Of

Upstream validation warnings.

Warningsobject
Show Child Parameters
Example

ExperienceNameType

string

Using this class similar to app/model/shared.py CampaignType due in http call to
report service carousel has a different value and in the path we need to do
case-insensitive since this value is a path param

Allowed values:PLACarousel

FilterOperator

string

Allowed values:EQUALSNOT_EQUALSGREATER_THANGREATER_THAN_OR_EQUALLESS_THANLESS_THAN_OR_EQUALLIKE_INNOT_INIS_NULLNOT_NULLNOT_LIKEBETWEEN