---
title: "Check fixed tenancy campaign availability"
method: POST
path: "/v3/product-campaigns:checkFixedTenancyAvailable"
tags: ["productCampaign"]
---

# Check fixed tenancy campaign availability

`POST /v3/product-campaigns:checkFixedTenancyAvailable`

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.

## Request body

- Campaignv3CheckProductCampaignFixedTenancyAvailableRequest
  - `campaignId` string — The unique identifier of the campaign.
  - `placementId` string, required — The unique identifier of the placement.
  - `catalogIds` string[], required — The unique identifier of the retailer's catalog.
  - `startTime` string, date-time, required — When the campaign starts as a precise ISO-8601 timestamp.
  - `endTime` string, date-time, required — When the campaign ends as a precise ISO-8601 timestamp. If removed then the campaign will be treated as 'ALWAYS ON'.
  - `searchTerms` Campaignv3SearchTerm[]
    - `phrase` string — The keyword you want to target in your campaign, with a maximum length of 150 characters.
    - `matchType` 'MATCH_TYPE_UNSPECIFIED' | 'MATCH_TYPE_PHRASE_MATCH' | 'MATCH_TYPE_EXACT_MATCH'
    - `collectionName` string — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise.
    - `suggested` boolean — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise.
    - `excludedProducts` Campaignv3CatalogProductSeller[] — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise.
      - `catalogId` string — The unique identifier of the retailer's catalog.
      - `productCode` string — The product code within the catalog.
      - `sellerId` string — The seller ID for the product. Defaults to an empty string.
    - `maxBid` string — The maximum cost per click bid for the search term, overriding the auction's default max bid for that term.
    - `treatAsCustom` boolean — Flag that determines whether the search term is treated as custom. Custom terms apply to all products in the campaign. This flag should only be used when the placement supports suggested search terms and allows custom terms.
  - `filters` Campaignv3TargetedFilter[]
    - `catalogId` string — The unique identifier of the retailer's catalog.
    - `filter` string — The product filter targeted by the campaign.
  - `positions` integer[], required — The fixed tenancy positions to be booked by the campaign.

## Response `200`

A successful response.

- Campaignv3CheckProductCampaignFixedTenancyAvailableResponse
  - `available` boolean
  - `conflicts` Campaignv3CheckProductCampaignFixedTenancyAvailableResponseFixedTenancyConflict[]
    - `searchTerm` Campaignv3SearchTerm
      - `phrase` string — The keyword you want to target in your campaign, with a maximum length of 150 characters.
      - `matchType` 'MATCH_TYPE_UNSPECIFIED' | 'MATCH_TYPE_PHRASE_MATCH' | 'MATCH_TYPE_EXACT_MATCH'
      - `collectionName` string — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise.
      - `suggested` boolean — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise.
      - `excludedProducts` Campaignv3CatalogProductSeller[] — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise.
        - `catalogId` string — The unique identifier of the retailer's catalog.
        - `productCode` string — The product code within the catalog.
        - `sellerId` string — The seller ID for the product. Defaults to an empty string.
      - `maxBid` string — The maximum cost per click bid for the search term, overriding the auction's default max bid for that term.
      - `treatAsCustom` boolean — Flag that determines whether the search term is treated as custom. Custom terms apply to all products in the campaign. This flag should only be used when the placement supports suggested search terms and allows custom terms.
    - `filter` Campaignv3TargetedFilter
      - `catalogId` string — The unique identifier of the retailer's catalog.
      - `filter` string — The product filter targeted by the campaign.
    - `startTime` string, date-time
    - `endTime` string, date-time
    - `campaignIds` string[]
    - `catalogId` string
    - `placementId` string

## Other responses

- `400` — There was a problem with input.
- `401` — Login failed or token not valid.
- `403` — Access denied due to insufficient permissions.
- `default` — An unexpected error response.

---

[API](https://skmtc.net/citrusad/apis/citrus-auth-api.md) · [All operations](https://skmtc.net/citrusad/apis/citrus-auth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/citrusad/citrus-auth-api/revisions/a040003c7378/schema)