Skip to main content
POST
Connect CitrusAd

Authorizations

Authorization
string
header
required

API key or access token

Body

application/json

Connects CitrusAd using the standard sponsored-products composition. API credentials are stored separately through the CitrusAd ad-server credential endpoint.

environment
enum<string>
required
Available options:
sandbox,
production
teamId
string
required
Required string length: 1 - 255
namespaces
object[]
required
Minimum array length: 1
defaultCurrency
string
required
Pattern: ^[A-Za-z]{3}$
sourceId
string
Required string length: 1 - 255
Pattern: ^[a-z0-9][a-z0-9_-]*$
name
string
Required string length: 1 - 255
floorPrice
number
Required range: x >= 0

Response

Connect CitrusAd

Seller-facing CitrusAd ad-server connection. Internal recipe modules are intentionally not exposed.

inventorySourceId
string
required
sourceId
string
required
provider
enum<string>
required
Available options:
citrusad
connectionType
enum<string>
required
Available options:
AD_SERVER
status
enum<string>
required
Available options:
CONFIGURING
credentialRequired
enum<boolean>
required
Available options:
true
supportedFormatIds
enum<string>[]
required
Available options:
citrusad_sponsored_product