Connect CitrusAd
curl --request POST \
--url https://api.interchange.io/api/v2/storefront/inventory-sources/ad-servers/citrusad \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"teamId": "<string>",
"namespaces": [
{
"namespace": "<string>",
"retailerName": "<string>",
"publisherDomain": "<string>"
}
],
"defaultCurrency": "<string>"
}
'import requests
url = "https://api.interchange.io/api/v2/storefront/inventory-sources/ad-servers/citrusad"
payload = {
"teamId": "<string>",
"namespaces": [
{
"namespace": "<string>",
"retailerName": "<string>",
"publisherDomain": "<string>"
}
],
"defaultCurrency": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
teamId: '<string>',
namespaces: [{namespace: '<string>', retailerName: '<string>', publisherDomain: '<string>'}],
defaultCurrency: '<string>'
})
};
fetch('https://api.interchange.io/api/v2/storefront/inventory-sources/ad-servers/citrusad', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"inventorySourceId": "<string>",
"sourceId": "<string>",
"provider": "citrusad",
"connectionType": "AD_SERVER",
"status": "CONFIGURING",
"credentialRequired": true,
"supportedFormatIds": [
"citrusad_sponsored_product"
]
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Storefront
Connect CitrusAd
Connect CitrusAd as an ad server using the standard sponsored-products composition. The connection appears as one inventory source; its internal modules are implementation details. Store credentials separately through the CitrusAd ad-server credential endpoint.
POST
/
inventory-sources
/
ad-servers
/
citrusad
Connect CitrusAd
curl --request POST \
--url https://api.interchange.io/api/v2/storefront/inventory-sources/ad-servers/citrusad \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"teamId": "<string>",
"namespaces": [
{
"namespace": "<string>",
"retailerName": "<string>",
"publisherDomain": "<string>"
}
],
"defaultCurrency": "<string>"
}
'import requests
url = "https://api.interchange.io/api/v2/storefront/inventory-sources/ad-servers/citrusad"
payload = {
"teamId": "<string>",
"namespaces": [
{
"namespace": "<string>",
"retailerName": "<string>",
"publisherDomain": "<string>"
}
],
"defaultCurrency": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
teamId: '<string>',
namespaces: [{namespace: '<string>', retailerName: '<string>', publisherDomain: '<string>'}],
defaultCurrency: '<string>'
})
};
fetch('https://api.interchange.io/api/v2/storefront/inventory-sources/ad-servers/citrusad', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"inventorySourceId": "<string>",
"sourceId": "<string>",
"provider": "citrusad",
"connectionType": "AD_SERVER",
"status": "CONFIGURING",
"credentialRequired": true,
"supportedFormatIds": [
"citrusad_sponsored_product"
]
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
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.
Available options:
sandbox, production Required string length:
1 - 255Minimum array length:
1Show child attributes
Show child attributes
Pattern:
^[A-Za-z]{3}$Required string length:
1 - 255Pattern:
^[a-z0-9][a-z0-9_-]*$Required string length:
1 - 255Required range:
x >= 0Response
Connect CitrusAd
Seller-facing CitrusAd ad-server connection. Internal recipe modules are intentionally not exposed.
Available options:
citrusad Available options:
AD_SERVER Available options:
CONFIGURING Available options:
true Available options:
citrusad_sponsored_product