v1

latestOpenAPI 3.0.02026-07-2466275257.1 KB

productCampaign

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 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/v3/product-campaigns/{id}

Path parameters

idstring required

Response

The product campaign object for requested id.

Example response

{
  "productCampaign": {
    "advertisedProducts": {
      "productsByKey": [
        {
          "catalogId": "catalog_001",
          "productCode": "PROD123456",
          "sellerId": "seller_78910"
        }
      ]
    },
    "targeting": {
      "searchTerms": [
        {
          "phrase": "example search term",
          "collectionName": "default_collection",
          "suggested": true,
          "excludedProducts": [
            {
              "catalogId": "catalog_001",
              "productCode": "PROD123456",
              "sellerId": "seller_78910"
            }
          ],
          "maxBid": "100.00",
          "treatAsCustom": true
        }
      ],
      "crossSell": {
        "targetProductsByKey": [
          {
            "catalogId": "catalog_001",
            "productCode": "PROD123456",
            "sellerId": "seller_78910"
          }
        ]
      },
      "upsell": {
        "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"
        }
      ]
    },
    "strategy": {
      "auction": {
        "maxBid": "$100.00",
        "spendLimit": {
          "daily": "$50.00",
          "total": "$1000.00"
        }
      },
      "fixedTenancy": {
        "cost": "$99.99",
        "positions": [
          1,
          2,
          3
        ],
        "catalogCosts": [
          {
            "catalogId": "catalog_123456",
            "catalogCostPercentage": 0.25
          }
        ]
      }
    },
    "fixedCosts": {
      "dataCost": "$100.00",
      "creativeCost": "$200.00",
      "otherCost": "$50.00"
    },
    "customFields": [
      {
        "customFieldId": "cfid_12345",
        "content": "This is a custom field content."
      }
    ],
    "customQuestions": [
      {
        "customQuestionId": "cqid_67890",
        "answers": [
          "Answer 1",
          "Answer 2",
          "Answer 3"
        ]
      }
    ]
  }
}