API Reference

The store object

Attributes

Id intege3

Unique identifier for the object referred to as the impact.com Store Id.

Name string

Name of the store.

NumberOfGroups integer

Number of groups in the store.

DateLastUpdated string

Date and time the store was last updated in ISO 8601 format.

Groups array

A list of the store’s groups.

View child attributes

Id integer

Unique identifier for the Group object

Name string

Name of the group

NumberOfProducts integer

Number of products in the group.

DateLastUpdated string

Date and time the store was last updated in ISO 8601 format.

StartDate string

Date and time (in ISO 8601 format) that the store is first made available on the platform.

EndDate string

Date and time (in ISO 8601 format) that the store is made unavailable on the platform.

Status enum

Status of the group.

View possible enum values
ACTIVEThe group is active.
DISABLEDThe group is not active.

CatalogId integer

Unique identifier for the object referred to as the impact.com Catalog Id.

Uri string

Full URL of an endpoint to call to view a group’s details.

ItemsUri string

Direct URI of an endpoint to call to view a list of items.

{
      "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"
    }

StoreUri string

Full URL to see a store’s details in a web browser.

Uri string

Direct URI to view a store’s details when calling this endpoint.

{
  "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"
    }
  ]
}