API Reference

Retrieve a store

Retrieves a store’s details. You need to pass the unique impact.com Store Id that was returned when listing stores.

Parameters

ShowAutoCreatedGroups optional

Defaults to TRUE. impact.com automatically groups products for brands when they create their storefront. Set ShowAutoCreatedGroups to FALSE if you would like to exclude these automatically-created groups and only display the brand-curated groups.

Returns

Returns a store object if a valid identifier is provided. Returns an error for invalid or deleted contact identifiers.

Example request

curl 'https://api.impact.com/Mediapartners/<AccountSID>/Stores?ShowAutoCreatedGroups=FALSE' \ 
 -X GET \ 
 -u '<AccountSID>:<AuthToken>' \ 
 -H 'Accept: application/json'

Example response

{
  "Id": "8123",
  "Name": "ACME Campaign",
  "NumberOfGroups": "1",
  "DateLastUpdated": "2022-09-01T19:32:12-07:00",
  "StoreUri": "https:/acme.impactradius.net/secure/mediapartner/ads/view-partner-storefront-flow.ihtml?storefrontId=8123",
  "Uri": "/Mediapartners/<AccountSID>/Stores/8123",
  "Groups": [
      {
      "Id": "555",
      "Name": "ACME Group",
      "NumberOfProducts": "5",
      "DateLastUpdated": "2022-10-04T00:22:06-07:00",
      "StartDate": "",
      "EndDate": "",
      "Status": "ACTIVE",
      "CatalogId": "9999",
      "Uri": "https://example.com/secure/mediapartner/ads/view-products-flow.ihtml#/partnerproducts/campaignId=8123&ProductGroups=555",
      "ItemsUri": "/Mediapartners/IRjnYtzeHhaR116142yBQMg6n76dULQUn1/Stores/8123/Group/555/Items"
    }
  ]
}