v1

latestOpenAPI 3.0.02026-07-2466275257.1 KB

productCampaign

Check fixed tenancy campaign availability

This endpoint checks if a fixed tenancy campaign can be booked for specified dates and placement. It shows any conflicts with existing campaigns and confirms availability.

post/v3/product-campaigns:checkFixedTenancyAvailable

Request body

campaignIdstring

The unique identifier of the campaign.

placementIdstring required

The unique identifier of the placement.

catalogIdsstring[] required

The unique identifier of the retailer's catalog.

startTimestring date-time required

When the campaign starts as a precise ISO-8601 timestamp.

endTimestring date-time required

When the campaign ends as a precise ISO-8601 timestamp. If removed then the campaign will be treated as 'ALWAYS ON'.

positionsinteger[] required

The fixed tenancy positions to be booked by the campaign.

Example request

{
  "searchTerms": [
    {
      "phrase": "example search term",
      "collectionName": "default_collection",
      "suggested": true,
      "excludedProducts": [
        {
          "catalogId": "catalog_001",
          "productCode": "PROD123456",
          "sellerId": "seller_78910"
        }
      ],
      "maxBid": "100.00",
      "treatAsCustom": true
    }
  ],
  "filters": [
    {
      "catalogId": "catalog_12345",
      "filter": "filter_value_abc"
    }
  ]
}

Response

A successful response.

availableboolean

Example response

{
  "conflicts": [
    {
      "searchTerm": {
        "phrase": "example search term",
        "collectionName": "default_collection",
        "suggested": true,
        "excludedProducts": [
          {
            "catalogId": "catalog_001",
            "productCode": "PROD123456",
            "sellerId": "seller_78910"
          }
        ],
        "maxBid": "100.00",
        "treatAsCustom": true
      },
      "filter": {
        "catalogId": "catalog_12345",
        "filter": "filter_value_abc"
      }
    }
  ]
}