Get Offers
Variables - Details
| Name | Description | Required |
|---|---|---|
| customerRelationshipId | CMT based variable to uniquely identify | Required |
| serviceAccountNumber | XBO Service Account Number | Required |
| affiliate | Unique identifier of the sales affiliate | Required |
| channel | Unique identifier of the sales channel | Required |
| appId | Application Id within the sales channel | Required |
API Specs
GraphQL API
Ready
This API is available in both integration and production.
| HTTP Item | HTTP Value |
|---|---|
| Url | https://{host}/graphql |
| Method | POST |
mutation Mutation($salesContext: SalesContextInput) {
createSalesContext(salesContext: $salesContext) {
salesJourneyId
offers {
... // Offers node is available to query
}
}
}
{
"salesContext": {
"account": {
"customerRelationshipId": "82aae449-7f55-46c6-800f-89f319e38230002",
"serviceAccountNumber" : "234234876987987239"
},
"source": {
"affiliate": "XUMO",
"channel": "WEB",
"appId": "WEB_PORTAL"
}
}
}
None
None
{
"salesJourneyId" : "32423423",
"offers" :[
{
"allowedActions": [
"ADD"
],
"offerId": "CS_OFFER_000003",
"availToBuy": 1,
"availToRemove": 0,
"qtyInAccount": null,
"qtyInCart": 0,
"productFamily": "",
"partnerGroup": "CONTENT_STORE",
"activationStatus": null,
"purchasedOfferId": null,
"subscriptionDetails": null,
"chargeDetails": [
{
"currency": "USD",
"recurringCharges": [
{
"chargeAmount": 6.99,
"duration": 0,
"startMonth": 1
}
]
}
],
"metadata": [
{
"name": "productName",
"value": "Anime_Network"
}
//....
]
"presentationContents" : [
{
"name": "productName",
"content": "Anime_Network"
}
//....
]
}
//.... more offers
]
}
{
"errors" : []
}
Coming soon
REST API
Info
This API is available in integration. Will be available in production in few days.
| HTTP Item | HTTP Value |
|---|---|
| Url | https://{host}/v1/salesJourneys/{salesJourneyId}/offers |
| Method | GET |
None
| Param Name | Description | Required |
|---|---|---|
| salesJourneyId | salesJourneyId that we got from init step | Required |
{
"salesJourneyId" : "32423423",
"offers" :[
{
"allowedActions": [
"ADD"
],
"offerId": "CS_OFFER_000003",
"availToBuy": 1,
"availToRemove": 0,
"qtyInAccount": null,
"qtyInCart": 0,
"productFamily": "",
"partnerGroup": "CONTENT_STORE",
"activationStatus": null,
"purchasedOfferId": null,
"subscriptionDetails": null,
"chargeDetails": [
{
"currency": "USD",
"recurringCharges": [
{
"chargeAmount": 6.99,
"duration": 0,
"startMonth": 1
}
]
}
],
"metadata": [
{
"name": "productName",
"value": "Anime_Network"
}
//....
]
"presentationContents" : [
{
"name": "productName",
"content": "Anime_Network"
}
//....
]
}
//.... more offers
]
}
{
"errorCode" : "",
"errorMessage" : "",
"severity" : ""
}
Coming soon
REST API - V2
Info
This API is available in integration. Will be available in production in few days.
Get offers by account
| HTTP Item | HTTP Value |
|---|---|
| Url | https://{host}/v2/partners/{partnerId}/accounts/{serviceAccountNumber}/offers |
| Method | GET |
| Header | Description | Required |
|---|---|---|
| clprop | Client property, Eg: affiliate=XSB,channel=DEVICE,appId=UCO | Required |
None
| Param Name | Description | Required |
|---|---|---|
| partnerId | Partner id such as xglobal/comcast | Required |
| serviceAccountNumber | XBO service account number | Required |
{
"offers" : [
{
"isSubscribed": false,
"subscriptionDetails": null,
"offer": {
"offerDetails": {
"publisher": "APPLE",
"durableAppId": null,
"appId": "apple_inc_apple_tv_mls",
"offerCode": "EPO-90-200009",
"displayName": "MLS Season Pass",
"description": "SPORTS - MLS Season Pass ALC",
"offerType": "Feature",
"productType": "Feature",
"productFamily": "MLS",
"familyProductRank": null,
"associatedProduct": {},
"source": "xcp",
"childrenProducts": [
{}
]
},
"price": {
"listPrice": 99,
"currency": "USD",
"chargeType": "RECURRING",
"chargeFrequency": "MONTHLY"
},
"offerPresentation": {
"displayName": "MLS Season Pass",
"publisherAppName": "Apple TV",
"localizedTermsAndConditions": [
{
"locale": "en",
"terms": "Subscribe to MLS Season Pass (Season) for $99 this season. Plan automatically renews for $99 per season starting next season until canceled. Cancel anytime at xumo.com/subscriptions at least a day before each renewal date. You will not be charged again until the next season starts, currently expected for February 2024. If no longer subscribed to Apple TV+ , plan renews for the regular plan price of $99 per season. Pricing subject to change. Taxes and fees extra. To access Apple TV+ or MLS content, activation of an Apple account is required."
}
],
"localizedConfirmation": [
{
"locale": "en",
"confirmationMessage": null
}
],
"localizedTitle": [
{
"locale": "en",
"title": "Get the Apple TV+ app, home of Apple Originals and MLS Season Pass."
}
],
"localizedDescription": [
{
"locale": "en",
"description": "Easily add and manage Apple TV+ and MLS Season Pass with Xumo."
}
],
"localizedHighlights": [
{
"locale": "en",
"higlights": [
"Watch every Major League Soccer match, including playoffs",
"No blackouts or restrictions",
"Renews next season"
]
}
],
"localizedChannels": [
{
"locale": "en",
"channels": null
}
],
"offerImageDetails": [
{
"offerImage": {
"imageType": "ImageURL",
"imageUrl": "https://assets.xfinity.com/assets/dotcom/flex/mls_seasonpass.svg"
}
}
],
"offerFooter": [
{
"locale": "en",
"footer": null
}
],
"offPlatformSubscription": true,
"offPlatformHandoffDetails": {
"offPlatformCodeUrl": null,
"offPlatformHandoffDescription": [
{
"locale": "en",
"higlights": ""
}
]
}
}
}
}
]
}
{
"errorCode" : "",
"errorMessage" : "",
"severity" : ""
}
Coming soon
Get offers by salesJourneyId
Info
This API is available in integration. Will be available in production in few days.
| HTTP Item | HTTP Value |
|---|---|
| Url | https://{host}/v2/partners/{partnerId}/accounts/{serviceAccountNumber}/salesJourneys/{salesJourneyId}/offers |
| Method | GET |
None
| Param Name | Description | Required |
|---|---|---|
| partnerId | Partner id such as xglobal/comcast | Required |
| serviceAccountNumber | XBO service account number | Required |
| salesJourneyId | salesJourneyId that we got from init step | Required |
{
"offers" : [
{
"isSubscribed": false,
"subscriptionDetails": null,
"offer": {
"offerDetails": {
"publisher": "APPLE",
"durableAppId": null,
"appId": "apple_inc_apple_tv_mls",
"offerCode": "EPO-90-200009",
"displayName": "MLS Season Pass",
"description": "SPORTS - MLS Season Pass ALC",
"offerType": "Feature",
"productType": "Feature",
"productFamily": "MLS",
"familyProductRank": null,
"associatedProduct": {},
"source": "xcp",
"childrenProducts": [
{}
]
},
"price": {
"listPrice": 99,
"currency": "USD",
"chargeType": "RECURRING",
"chargeFrequency": "MONTHLY"
},
"offerPresentation": {
"displayName": "MLS Season Pass",
"publisherAppName": "Apple TV",
"localizedTermsAndConditions": [
{
"locale": "en",
"terms": "Subscribe to MLS Season Pass (Season) for $99 this season. Plan automatically renews for $99 per season starting next season until canceled. Cancel anytime at xumo.com/subscriptions at least a day before each renewal date. You will not be charged again until the next season starts, currently expected for February 2024. If no longer subscribed to Apple TV+ , plan renews for the regular plan price of $99 per season. Pricing subject to change. Taxes and fees extra. To access Apple TV+ or MLS content, activation of an Apple account is required."
}
],
"localizedConfirmation": [
{
"locale": "en",
"confirmationMessage": null
}
],
"localizedTitle": [
{
"locale": "en",
"title": "Get the Apple TV+ app, home of Apple Originals and MLS Season Pass."
}
],
"localizedDescription": [
{
"locale": "en",
"description": "Easily add and manage Apple TV+ and MLS Season Pass with Xumo."
}
],
"localizedHighlights": [
{
"locale": "en",
"higlights": [
"Watch every Major League Soccer match, including playoffs",
"No blackouts or restrictions",
"Renews next season"
]
}
],
"localizedChannels": [
{
"locale": "en",
"channels": null
}
],
"offerImageDetails": [
{
"offerImage": {
"imageType": "ImageURL",
"imageUrl": "https://assets.xfinity.com/assets/dotcom/flex/mls_seasonpass.svg"
}
}
],
"offerFooter": [
{
"locale": "en",
"footer": null
}
],
"offPlatformSubscription": true,
"offPlatformHandoffDetails": {
"offPlatformCodeUrl": null,
"offPlatformHandoffDescription": [
{
"locale": "en",
"higlights": ""
}
]
}
}
}
}
]
}
{
"errorCode" : "",
"errorMessage" : "",
"severity" : ""
}
Coming soon
Get offer by account
Info
This API is available in integration. Will be available in production in few days.
| HTTP Item | HTTP Value |
|---|---|
| Url | https://{host}/v2/partners/{partnerId}/accounts/{serviceAccountNumber}/offers/{offerId} |
| Method | GET |
| Header | Description | Required |
|---|---|---|
| clprop | Client property, Eg: affiliate=XSB,channel=DEVICE,appId=UCO | Required |
None
| Param Name | Description | Required |
|---|---|---|
| partnerId | Partner id such as xglobal/comcast | Required |
| serviceAccountNumber | XBO service account number | Required |
| offerId | offerId that is being queried for | Required |
{
"offer" : {
"isSubscribed": false,
"subscriptionDetails": null,
"publisher": "APPLE",
"durableAppId": null,
"appId": "apple_inc_apple_tv_mls",
"offerCode": "EPO-90-200009",
"displayName": "MLS Season Pass",
"description": "SPORTS - MLS Season Pass ALC",
"offerType": "Feature",
"productType": "Feature",
"productFamily": "MLS",
"familyProductRank": null,
"associatedProduct": {},
"source": "xcp",
"childrenProducts": [
{}
]
"price": {
"listPrice": 99,
"currency": "USD",
"chargeType": "RECURRING",
"chargeFrequency": "MONTHLY"
},
"offerPresentation": {
"displayName": "MLS Season Pass",
"publisherAppName": "Apple TV",
"localizedTermsAndConditions": [
{
"locale": "en",
"terms": "Subscribe to MLS Season Pass (Season) for $99 this season. Plan automatically renews for $99 per season starting next season until canceled. Cancel anytime at xumo.com/subscriptions at least a day before each renewal date. You will not be charged again until the next season starts, currently expected for February 2024. If no longer subscribed to Apple TV+ , plan renews for the regular plan price of $99 per season. Pricing subject to change. Taxes and fees extra. To access Apple TV+ or MLS content, activation of an Apple account is required."
}
],
"localizedConfirmation": [
{
"locale": "en",
"confirmationMessage": null
}
],
"localizedTitle": [
{
"locale": "en",
"title": "Get the Apple TV+ app, home of Apple Originals and MLS Season Pass."
}
],
"localizedDescription": [
{
"locale": "en",
"description": "Easily add and manage Apple TV+ and MLS Season Pass with Xumo."
}
],
"localizedHighlights": [
{
"locale": "en",
"higlights": [
"Watch every Major League Soccer match, including playoffs",
"No blackouts or restrictions",
"Renews next season"
]
}
],
"localizedChannels": [
{
"locale": "en",
"channels": null
}
],
"offerImageDetails": [
{
"offerImage": {
"imageType": "ImageURL",
"imageUrl": "https://assets.xfinity.com/assets/dotcom/flex/mls_seasonpass.svg"
}
}
],
"offerFooter": [
{
"locale": "en",
"footer": null
}
],
"offPlatformSubscription": true,
"offPlatformHandoffDetails": {
"offPlatformCodeUrl": null,
"offPlatformHandoffDescription": [
{
"locale": "en",
"higlights": ""
}
]
}
}
}
}
{
"errorCode" : "",
"errorMessage" : "",
"severity" : ""
}
Coming soon
Get offer by salesJourneyId
Info
This API is available in integration. Will be available in production in few days.
| HTTP Item | HTTP Value |
|---|---|
| Url | https://{host}/v2/partners/{partnerId}/accounts/{serviceAccountNumber}/salesJourneys/{salesJourneyId}/offers/{offerId} |
| Method | GET |
None
| Param Name | Description | Required |
|---|---|---|
| partnerId | Partner id such as xglobal/comcast | Required |
| serviceAccountNumber | XBO service account number | Required |
| salesJourneyId | salesJourneyId that we got from init step | Required |
| offerId | offerId that we are specifically querying for | Required |
{
"offer" : {
"isSubscribed": false,
"subscriptionDetails": null,
"publisher": "APPLE",
"durableAppId": null,
"appId": "apple_inc_apple_tv_mls",
"offerCode": "EPO-90-200009",
"displayName": "MLS Season Pass",
"description": "SPORTS - MLS Season Pass ALC",
"offerType": "Feature",
"productType": "Feature",
"productFamily": "MLS",
"familyProductRank": null,
"associatedProduct": {},
"source": "xcp",
"childrenProducts": [
{}
]
"price": {
"listPrice": 99,
"currency": "USD",
"chargeType": "RECURRING",
"chargeFrequency": "MONTHLY"
},
"offerPresentation": {
"displayName": "MLS Season Pass",
"publisherAppName": "Apple TV",
"localizedTermsAndConditions": [
{
"locale": "en",
"terms": "Subscribe to MLS Season Pass (Season) for $99 this season. Plan automatically renews for $99 per season starting next season until canceled. Cancel anytime at xumo.com/subscriptions at least a day before each renewal date. You will not be charged again until the next season starts, currently expected for February 2024. If no longer subscribed to Apple TV+ , plan renews for the regular plan price of $99 per season. Pricing subject to change. Taxes and fees extra. To access Apple TV+ or MLS content, activation of an Apple account is required."
}
],
"localizedConfirmation": [
{
"locale": "en",
"confirmationMessage": null
}
],
"localizedTitle": [
{
"locale": "en",
"title": "Get the Apple TV+ app, home of Apple Originals and MLS Season Pass."
}
],
"localizedDescription": [
{
"locale": "en",
"description": "Easily add and manage Apple TV+ and MLS Season Pass with Xumo."
}
],
"localizedHighlights": [
{
"locale": "en",
"higlights": [
"Watch every Major League Soccer match, including playoffs",
"No blackouts or restrictions",
"Renews next season"
]
}
],
"localizedChannels": [
{
"locale": "en",
"channels": null
}
],
"offerImageDetails": [
{
"offerImage": {
"imageType": "ImageURL",
"imageUrl": "https://assets.xfinity.com/assets/dotcom/flex/mls_seasonpass.svg"
}
}
],
"offerFooter": [
{
"locale": "en",
"footer": null
}
],
"offPlatformSubscription": true,
"offPlatformHandoffDetails": {
"offPlatformCodeUrl": null,
"offPlatformHandoffDescription": [
{
"locale": "en",
"higlights": ""
}
]
}
}
}
}
{
"errorCode" : "",
"errorMessage" : "",
"severity" : ""
}
Coming soon