Get product campaign for specified ID

This endpoint retrieves the complete details of a specific product campaign using its unique ID. View all campaign settings, performance data, and current status. Note: requestTeamId is required for s

Epsilon Retail Media's documentation is now centralized with our knowledgebase!

For up to date guides, please view this page in the new Partner APIs space of our documentation.

---

description: "This endpoint retrieves the complete details of a specific product campaign using its unique ID. View all campaign settings, performance data, and current status. Note: requestTeamId is required for supplier (advertiser) users and must match the team that owns the campaign. Retailer users may omit it. Requests from supplier users without a valid requestTeamId will fail with a 400 or 403 error."

Get product campaign for specified ID

Get product campaign for specified ID

get

This endpoint retrieves the complete details of a specific product campaign using its unique ID. View all campaign settings, performance data, and current status. Note: requestTeamId is required for supplier (advertiser) users and must match the team that owns the campaign. Retailer users may omit it. Requests from supplier users without a valid requestTeamId will fail with a 400 or 403 error.

Authorizations

AuthorizationstringRequired

For accessing the API a valid JWT jwt must be passed in all queries in the 'Authorization' header. The following syntax must be used in the 'Authorization' header. (Bearer xxx.yyy.zzz)

Path parameters

idstringRequired

Responses

200

The product campaign object for requested id.

application/json

400

There was a problem with input.

application/json

401

Login failed or token not valid.

application/json

403

Access denied due to insufficient permissions.

application/json

404

Product campaign for specified id does not exist.

application/json

default

An unexpected error response.

application/json

get/v3/product-campaigns/{id}

GET /v3/product-campaigns/{id} HTTP/1.1
Host: campaign.<env>.citrusad.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "productCampaign": {
    "advertisedProducts": {
      "productGroupList": [
        "text"
      ],
      "productsByAttributes": {
        "priceRange": {
          "max": "100",
          "min": "10"
        },
        "tags": [
          "tag1",
          "tag2",
          "tag3"
        ]
      },
      "productsByKey": [
        {
          "catalogId": "catalog_001",
          "productCode": "PROD123456",
          "sellerId": "seller_78910"
        }
      ]
    },
    "approval": {
      "rejectionReason": "text",
      "state": "APPROVAL_STATE_PENDING"
    },
    "campaignState": "CAMPAIGN_STATE_ACTIVE",
    "catalogIds": [
      "text"
    ],
    "customFields": [
      {
        "content": "This is a custom field content.",
        "customFieldId": "cfid_12345"
      }
    ],
    "customQuestions": [
      {
        "answers": [
          "Answer 1",
          "Answer 2",
          "Answer 3"
        ],
        "customQuestionId": "cqid_67890"
      }
    ],
    "endTime": "2026-01-01T00:00:00.000Z",
    "fixedCosts": {
      "creativeCost": "$200.00",
      "dataCost": "$100.00",
      "otherCost": "$50.00"
    },
    "id": "text",
    "managerTeamId": "text",
    "name": "text",
    "namespaceId": "text",
    "placementId": "text",
    "sellerId": "text",
    "startTime": "2026-01-01T00:00:00.000Z",
    "strategy": {
      "auction": {
        "automatedBid": {
          "enableAutomatedBid": true,
          "objectiveType": "OBJECTIVE_TYPE_UNSPECIFIED",
          "targetRoas": "2.5"
        },
        "maxBid": "$100.00",
        "spendLimit": {
          "daily": "$50.00",
          "total": "$1000.00"
        }
      },
      "fixedTenancy": {
        "catalogCosts": [
          {
            "catalogCostPercentage": 0.25,
            "catalogId": "catalog_123456"
          }
        ],
        "cost": "$99.99",
        "positions": [
          1,
          2,
          3
        ]
      }
    },
    "targeting": {
      "audience": {
        "includeSegmentsSets": [
          {
            "segmentIds": [
              "text"
            ]
          }
        ]
      },
      "crossSell": {
        "targetProductsByAttributes": {
          "subclassTags": [
            "Electronics",
            "Home Appliances"
          ],
          "vendorTags": [
            "BrandX",
            "BrandY"
          ]
        },
        "targetProductsByKey": [
          {
            "catalogId": "catalog_001",
            "productCode": "PROD123456",
            "sellerId": "seller_78910"
          }
        ]
      },
      "excludeFilters": [
        {
          "catalogId": "catalog_12345",
          "filter": "filter_value_abc"
        }
      ],
      "includeFilters": [
        {
          "catalogId": "catalog_12345",
          "filter": "filter_value_abc"
        }
      ],
      "negativeSearchTerms": [
        {
          "matchType": "MATCH_TYPE_UNSPECIFIED",
          "phrase": "text"
        }
      ],
      "searchTerms": [
        {
          "collectionName": "default_collection",
          "excludedProducts": [
            {
              "catalogId": "catalog_001",
              "productCode": "PROD123456",
              "sellerId": "seller_78910"
            }
          ],
          "matchType": "MATCH_TYPE_UNSPECIFIED",
          "maxBid": "100.00",
          "phrase": "example search term",
          "suggested": true,
          "treatAsCustom": true
        }
      ],
      "upsell": {
        "targetProductsByAttributes": {
          "priceRange": {
            "max": "100",
            "min": "10"
          },
          "subclassTags": [
            "text"
          ],
          "vendorTags": [
            "text"
          ]
        },
        "targetProductsByKey": [
          {
            "catalogId": "catalog_001",
            "productCode": "PROD123456",
            "sellerId": "seller_78910"
          }
        ]
      }
    },
    "teamId": "text",
    "templateId": "text",
    "updateTime": "2026-01-01T00:00:00.000Z",
    "walletId": "text"
  }
}