Kroger Ad Platform API

Get Addresses

Returns a list of all the available addresses for a given account. Read more about Addresses in the Media Platform Learning Center. Whenever there is an update to addresses, users are required to make a GET /accounts call. This will cache the updated addresses.Important: For Agency users, this endpoint will return available Agency and CPG addresses.CPG users are limited to retrieve CPG-only addresses.

get
https://api.8451.com/kap/v2/metadata/addresses

Query Parameters

account_idintegerrequired

The account id to get contacts for

offsetinteger

The offset of the first contact to return

Default:0

sizeinteger

The number of contacts to return

Default:10

>= 1<= 100

Response

application/json

Successful Response

AdvertiserAddressResponse

dataarray[object]required

List of Addresses.

Show Child Parameters
metaobjectrequired
Show Child Parameters
get/metadata/addresses
 
application/json

Get Placements

Returns a list of all the available placements. Read more about Placements in the Media Platform Learning Center.

get
https://api.8451.com/kap/v2/metadata/placements

Query Parameters

offsetinteger

The offset of the first placement to return

Default:0

sizeinteger

The number of placements to return

Default:10

>= 1<= 100

Response

application/json

Successful Response

PlacementResponse

dataarray[object]required

List of Placements.

Show Child Parameters
metaobjectrequired
Show Child Parameters
get/metadata/placements
 
application/json

Get Divisions

Returns a list of all the available division. Read more about Divisions in the Media Platform Learning Center.

get
https://api.8451.com/kap/v2/metadata/divisions

Query Parameters

offsetinteger

The offset of the first divisions to return

Default:0

sizeinteger

The number of divisions to return

Default:10

>= 1<= 100

Response

application/json

Successful Response

DivisionResponse

dataarray[object]required

List of Divisions.

Show Child Parameters
metaobjectrequired
Show Child Parameters
get/metadata/divisions
 
application/json

Get Targets

Returns a list of all the available targets.

get
https://api.8451.com/kap/v2/metadata/targets

Query Parameters

offsetinteger

The offset of the first target to return

Default:0

sizeinteger

The number of targets to return

Default:10

>= 1<= 100

Response

application/json

Successful Response

TargetResponse

dataarray[object]required

List of Targets.

Show Child Parameters
metaobjectrequired
Show Child Parameters
get/metadata/targets
 
application/json

Get Products

Returns a list of all the available products for a given advertiser.

get
https://api.8451.com/kap/v2/metadata/products

Query Parameters

advertiser_idintegerrequired

The advertiser ID to get products for

offsetinteger

The offset of the first product to return

Default:0

sizeinteger

The number of products to return

Default:10

>= 1<= 100

typestring

Type for this products

Allowed values:PLATOACAROUSEL

Response

application/json

Successful Response

ProductResponse

dataarray[object]required

List of Products.

Show Child Parameters
metaobjectrequired
Show Child Parameters
get/metadata/products
 
application/json