Query Reference
These queries are used to search product feed summaries and product details. Available to both advertisers and publishers across Shopping, Travel, and Finance verticals.
financeCreditCardProducts
Returns: FinanceCreditCardProducts!
Search for all common fields across finance credit card products.
| Argument | Type | Description |
|---|---|---|
companyId | ID! | Required. Your CJ Company ID (cid). |
adIds | [ID!] | Restrict results to these Ad IDs. |
productIds | [ID!] | Filter by specific product identifiers. |
itemListIds | [ID!] | Restrict results to products from these item list IDs. |
keywords | [String!] | Restrict results based on these keywords. |
title | String | Filter by card name (verbatim, including trademarks). HTML-encode any symbols. |
cardType | String | Filter by card type: CoBrand, Lending, Mileage, Rewards, etc. |
categories | String | Filter by relevant card categories. |
usageType | String | Filter by usage type: Consumer, Business, etc. |
promotionType | String | Filter by promotion type: Coupons, Sale/Discount, Free Shipping, Hot Product, etc. |
sinceLastUpdated | String | Fetch products updated since this date. |
beforeLastUpdated | String | Fetch products updated before this date. |
partnerIds | [ID!] | Publishers only. Restrict results to these advertiser partner IDs. Ignored for advertisers. |
partnerName | String | Publishers only. Restrict results to this partner name. Ignored for advertisers. |
partnerStatus | PartnerStatus | Publishers only. Filter by relationship status: joined or not-joined. Ignored for advertisers. |
limit | Int | Max records to return. Default 1,000. Max 10,000. |
offset | Int | Record number to start from. Use with limit for pagination. |
financeProducts
Returns: FinanceProducts!
Search for all common fields across all finance products.
| Argument | Type | Description |
|---|---|---|
companyId | ID! | Required. Your CJ Company ID (cid). |
adIds | [ID!] | Restrict results to these Ad IDs. |
productIds | [ID!] | Filter by specific product identifiers. |
itemListIds | [ID!] | Restrict results to products from these item list IDs. |
keywords | [String!] | Restrict results based on these keywords. |
title | String | Filter by card name (verbatim, including trademarks). HTML-encode any symbols. |
cardType | String | Filter by card type: CoBrand, Lending, Mileage, Rewards, etc. |
categories | String | Filter by relevant card categories. |
usageType | String | Filter by usage type: Consumer, Business, etc. |
promotionType | String | Filter by promotion type: Coupons, Sale/Discount, Free Shipping, Hot Product, etc. |
sinceLastUpdated | String | Fetch products updated since this date. |
beforeLastUpdated | String | Fetch products updated before this date. |
partnerIds | [ID!] | Publishers only. Restrict results to these advertiser partner IDs. Ignored for advertisers. |
partnerName | String | Publishers only. Restrict results to this partner name. Ignored for advertisers. |
partnerStatus | PartnerStatus | Publishers only. Filter by relationship status: joined or not-joined. Ignored for advertisers. |
limit | Int | Max records to return. Default 1,000. Max 10,000. |
offset | Int | Record number to start from. Use with limit for pagination. |
productFeeds
Returns: ProductFeeds!
Search for available product feed summaries by Ad ID.
| Argument | Type | Description |
|---|---|---|
companyId | ID! | Required. Your CJ Company ID (cid). |
partnerIds | [ID!] | Publishers only. Restrict results to these advertiser partner IDs. Ignored for advertisers. |
advertiserCountry | String | Publishers only. Restrict results to advertisers in this country. Ignored for advertisers. |
feedType | FeedType | Publishers only. Filter by feed type. Ignored for advertisers. |
limit | Int | Max records to return. Default 1,000. Max 10,000. |
offset | Int | Record number to start from. Use with limit for pagination. |
products
Returns: Products!
Search for all common fields across all product verticals (Shopping, Travel, Finance).
| Argument | Type | Description |
|---|---|---|
companyId | ID! | Required. Your CJ Company ID (cid). |
adIds | [ID!] | Restrict results to these Ad IDs. |
productIds | [ID!] | Filter by specific product identifiers. |
excludeProductIds | [ID!] | Exclude these product identifiers from results. |
itemListId | ID | Restrict results to products from this item list ID. |
itemListIds | [ID!] | Restrict results to products from these item list IDs. |
keywords | [String!] | Restrict results based on these keywords. |
currency | String | Filter by currency type. |
lowPrice | Float | Restrict results to products at or above this price. |
highPrice | Float | Restrict results to products at or below this price. |
includeDeletedProducts | Boolean | Include deleted products in results when true. |
sortBy | SortBy | Field by which to sort results. |
sortOrder | SortOrder | Sort direction: ASC or DESC. |
page | String | Page token from a previous response. Use for paginating beyond 10,000 records. |
partnerIds | [ID!] | Publishers only. Restrict results to these advertiser partner IDs. Ignored for advertisers. |
excludePartnerIds | [ID!] | Publishers only. Exclude these advertiser partner IDs from results. Ignored for advertisers. |
partnerStatus | PartnerStatus | Publishers only. Filter by relationship status: joined or not-joined. Ignored for advertisers. |
advertiserCountries | [String!] | Publishers only. Filter by advertiser country. Ignored for advertisers. |
availability | Availability | Publishers only. Filter by product availability. Ignored for advertisers. |
serviceableAreas | [String!] | Publishers only. Restrict results to advertisers serving these areas. Ignored for advertisers. |
excludeServiceableAreas | [String!] | Publishers only. Exclude advertisers serving these areas. Ignored for advertisers. |
limit | Int | Max records to return. Default 1,000. Max 10,000. |
offset | Int | Record number to start from. Use with limit for pagination. |
productsFromApplication
Returns: Products!
For CJ registered applications only. Contact the CJ Developer Experience Group ([email protected]) to discuss access.
| Argument | Type | Description |
|---|---|---|
advertiserId | ID! | Required. The advertiser that owns the products being searched. |
adIds | [ID!] | Restrict results to these Ad IDs. |
productIds | [ID!] | Filter by specific product identifiers. |
includeDeletedProducts | Boolean | Include deleted products in results when true. |
limit | Int | Max records to return. Default 1,000. Max 10,000. |
offset | Int | Record number to start from. Use with limit for pagination. |
shoppingProductFeeds
Returns: ShoppingProductFeeds!
Search for available Shopping product feed summaries by Ad ID.
| Argument | Type | Description |
|---|---|---|
companyId | ID! | Required. Your CJ Company ID (cid). |
partnerIds | [ID!] | Publishers only. Restrict results to these advertiser partner IDs. Ignored for advertisers. |
advertiserCountry | String | Publishers only. Restrict results to advertisers in this country. Ignored for advertisers. |
limit | Int | Max records to return. Default 1,000. Max 10,000. |
offset | Int | Record number to start from. Use with limit for pagination. |
shoppingProducts
Returns: ShoppingProducts!
Search for all fields across Shopping products.
| Argument | Type | Description |
|---|---|---|
companyId | ID! | Required. Your CJ Company ID (cid). |
adIds | [ID!] | Restrict results to these Ad IDs. |
productIds | [ID!] | Filter by specific product identifiers. |
itemListId | ID | Restrict results to products from this item list ID. |
itemListIds | [ID!] | Restrict results to products from these item list IDs. |
keywords | [String!] | Restrict results based on these keywords. |
gtin | String | Filter by Global Trade Item Number (GTIN/barcode). |
googleProductCategoryIds | [ID!] | Filter by Google-defined product category IDs. |
googleProductCategoryNames | [String!] | Filter by Google-defined product category names. |
currency | String | Filter by currency type. |
lowPrice | Float | Restrict results to products at or above this price. |
highPrice | Float | Restrict results to products at or below this price. |
includeDeletedProducts | Boolean | Include deleted products in results when true. |
partnerIds | [ID!] | Publishers only. Restrict results to these advertiser partner IDs. Ignored for advertisers. |
partnerStatus | PartnerStatus | Publishers only. Filter by relationship status: joined or not-joined. Ignored for advertisers. |
advertiserCountries | [String!] | Publishers only. Filter by advertiser country. Ignored for advertisers. |
availability | Availability | Publishers only. Filter by product availability. Ignored for advertisers. |
serviceableAreas | [String!] | Publishers only. Restrict results to advertisers serving these areas. Ignored for advertisers. |
limit | Int | Max records to return. Default 1,000. Max 10,000. |
offset | Int | Record number to start from. Use with limit for pagination. |
shoppingProductsFromApplication
Returns: ShoppingProducts!
For CJ registered applications only. Contact the CJ Developer Experience Group ([email protected]) to discuss access.
| Argument | Type | Description |
|---|---|---|
advertiserId | ID! | Required. The advertiser that owns the products being searched. |
productIds | [ID!] | Filter by specific product identifiers. |
includeDeletedProducts | Boolean | Include deleted products in results when true. |
limit | Int | Max records to return. Default 1,000. Max 10,000. |
offset | Int | Record number to start from. Use with limit for pagination. |
travelExperienceProducts
Returns: TravelExperienceProducts!
Search for all fields across Travel Experience products.
| Argument | Type | Description |
|---|---|---|
companyId | ID! | Required. Your CJ Company ID (cid). |
adIds | [ID!] | Restrict results to these Ad IDs. |
productIds | [ID!] | Filter by specific product identifiers. |
itemListId | ID | Restrict results to products from this item list ID. |
itemListIds | [ID!] | Restrict results to products from these item list IDs. |
keywords | [String!] | Restrict results based on these keywords. |
currency | String | Filter by currency type. |
lowPrice | Float | Restrict results to products at or above this price. |
highPrice | Float | Restrict results to products at or below this price. |
includeDeletedProducts | Boolean | Include deleted products in results when true. |
partnerIds | [ID!] | Publishers only. Restrict results to these advertiser partner IDs. Ignored for advertisers. |
partnerStatus | PartnerStatus | Publishers only. Filter by relationship status: joined or not-joined. Ignored for advertisers. |
advertiserCountries | [String!] | Publishers only. Filter by advertiser country. Ignored for advertisers. |
serviceableAreas | [String!] | Publishers only. Restrict results to advertisers serving these areas. Ignored for advertisers. |
limit | Int | Max records to return. Default 1,000. Max 10,000. |
offset | Int | Record number to start from. Use with limit for pagination. |
travelExperienceProductsFromApplication
Returns: TravelExperienceProducts!
For CJ registered applications only. Contact the CJ Developer Experience Group ([email protected]) to discuss access.
| Argument | Type | Description |
|---|---|---|
advertiserId | ID! | Required. The advertiser that owns the products being searched. |
productIds | [ID!] | Filter by specific product identifiers. |
includeDeletedProducts | Boolean | Include deleted products in results when true. |
limit | Int | Max records to return. Default 1,000. Max 10,000. |
offset | Int | Record number to start from. Use with limit for pagination. |
Updated 11 days ago