iCAS Sellside API
Overview
Authentication
Media Types
Content-Type and Accept Headers
Image Downloads
Feed Downloads
Customize response body
Dates and Times
Prices and Currencies
HTTP Response Codes and Error Handling
Dry-Run Request Validation
Vendor Ids
Page tokens
Authentication
What is OAuth 2.0
OAuth 2.0 Roles
OAuth 2.0 Endpoints
Getting an Access Token
Using an Access Token
Getting another Access Token
Refresh Tokens and Token Expiration
Scopes
Advertisements
Fields
Images
Campaigns
Fields
Categories
Category Ids
Category Levels
Category Status
Category Configuration
Intervals
Locales
Price Types
Data Model
Non-Leaf Categories
Leaf Categories
Attribute Groups
Attributes
Attribute Rendering
Attributes
Category Attributes
User-Defined Attributes
Regions
Region Ids
Region Levels
Region label
Region center
Data Model
Non-Leaf Regions
Leaf Regions
Feeds
File Format
Errors
Frequently Asked Questions
Feed Fields
vendor id
external id
seller name
title
description
category id
status
url
vanity url
price type
price
original price
item images
attributes
budget details
shipping & pick-up
phone number
email advertiser
region id
micro tip
MPN
google product category
product type
brand
GTIN
item group id
condition
material
energy efficiency class
min energy efficiency class
max energy efficiency class
color
gender
age group
size
unit pricing base measure
unit pricing measure
Reporting
Dimensions and Metrics
Time Ranges
Time Aggregation
Filters
Sorting
Pagination with offset and limit
Enrichment
Query and Response
Examples
Errors
Error Handling
OpenAPI reference
Release Notes
September 2024: ‘Deprecated handler clean up’
Feb 2023: ‘Campaigns & Micros’
Migration Guide
Key changes and benefits of migrating
Step by step guide
Campaigns
FAQ
References
Ad Status
Campaign Status
Error Codes
Price Types
iCAS Sellside API
Docs
»
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
A
ACTIVE
Ad Status
Campaign Status
Ad Status
ACTIVE
BUDGET_REACHED
DAILY_BUDGET_REACHED
DELETED
DELETED_BY_CS
DOMAIN_PENDING
PAUSED
SUSPENDED_BY_CS
ad_budgetsobj_daily
ad_budgetsobj_daily_limitMicros
ad_budgetsobj_daily_spentMicros
ad_budgetsobj_total
ad_budgetsobj_total_limitMicros
ad_budgetsobj_total_spentMicros
Ads
Advertisments
ageGroup
allowContactByEmail
allowPaypal
Attributes
attributes
,
[1]
Authentication
B
BIDDING
Price Types
BIDDING_FROM
Price Types
bidMicros
brand
BUDGET_REACHED
Ad Status
Campaign Status
budgetDetails
budgets
,
[1]
budgets.daily
budgets.daily.limitMicros
budgets.daily.spentMicros
budgets.total
budgets.total.limitMicros
budgets.total.spentMicros
C
Campaign Status
ACTIVE
BUDGET_REACHED
DAILY_BUDGET_REACHED
PAUSED
campaignId
Campaigns
categoryConfigV2
categoryId
,
[1]
color
condition
cpc
CREDIBLE_BID
Price Types
currency
D
DAILY_BUDGET_REACHED
Ad Status
Campaign Status
dailyBudget
dailySpent
dateCreated
,
[1]
dateDeleted
dateLastUpdated
,
[1]
DELETED
Ad Status
DELETED_BY_CS
Ad Status
description
,
[1]
DOMAIN_PENDING
Ad Status
E
emailAdvertiser
energyEfficiencyClass
Error Codes
Error Handling
externalId
,
[1]
F
FIXED_PRICE
Price Types
FREE
Price Types
G
gender
googleProductCategory
gtin
I
id
,
[1]
image objects
images
isDefault
itemGroupId
L
links.category
links.displayUrl
links.self
links.url
M
material
maxEnergyEfficiencyClass
media
microTip
,
[1]
minEnergyEfficiencyClass
mpn
N
NEGOTIABLE
Price Types
NOT_APPLICABLE
Price Types
O
ON_DEMAND
Price Types
originalPrice
P
pageNumber
PAUSED
Ad Status
Campaign Status
phoneNumber
,
[1]
postcode
price
,
[1]
(integer)
Price Types
BIDDING
BIDDING_FROM
CREDIBLE_BID
FIXED_PRICE
FREE
NEGOTIABLE
NOT_APPLICABLE
ON_DEMAND
RESERVED
SEE_DESCRIPTION
SWAP
price.amountCents
price.originalAmountCents
price.priceType
price.priceUnit
priceType
,
[1]
priceUnit
productType
R
regionId
,
[1]
Release Notes
RESERVED
Price Types
S
salutation
SEE_DESCRIPTION
Price Types
sellerName
,
[1]
shippingOptions
,
[1]
size
spentBudget
status
,
[1]
,
[2]
statusReasons
suggestedCpcForPageOne
SUSPENDED_BY_CS
Ad Status
SWAP
Price Types
T
title
,
[1]
,
[2]
totalBudget
U
unitPricingBaseMeasure
unitPricingMeasure
url
V
vanityUrl
vendorId
,
[1]
,
[2]