Search Consumer Offer
curl --request POST \
--url https://api.example.com/consumerOffers/search \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"consumer": {
"consumerIdentifier": "6X3D5MHHVSRGKDRLCHIC3Q2W2AQE55BK"
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({consumer: {consumerIdentifier: '6X3D5MHHVSRGKDRLCHIC3Q2W2AQE55BK'}})
};
fetch('https://api.example.com/consumerOffers/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.example.com/consumerOffers/search"
payload = { "consumer": { "consumerIdentifier": "6X3D5MHHVSRGKDRLCHIC3Q2W2AQE55BK" } }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)[
{
"consumerOffer": {
"consumerOfferId": "338d31e1-a289-40dd-beff-ab41c1fc5f51",
"offerId": "7560fca0-d8a9-4124-a172-924debec874e",
"consumer": {
"consumerIdentifier": "6X3D5MHHVSRGKDRLCHIC3Q2W2AQE55BK",
"billingIdentifier": "RDZN22AAVYAHVDN3N2OB2A7ADA3FVQWG",
"communicationInformation": {
"emailAddress": "example@bango.com",
"msisdn": "+441234567890"
}
},
"status": "REQUESTED",
"subStatus": "PENDING_CREATES",
"timeline": {
"createRequestedTs": "1970-01-01T00:00:00.000Z",
"createdTs": "1970-01-01T00:00:00.000Z",
"createsFailedTs": "1970-01-01T00:00:00.000Z",
"entitlementsRequestedTs": "1970-01-01T00:00:00.000Z",
"terminateRequestedTs": "1970-01-01T00:00:00.000Z"
}
},
"entitlements": [
{
"entitlementId": "b0163d06-1fa3-4c9b-a298-29635ca7151d",
"merchantAccountKey": "MY_CONTENT_PROVIDER",
"productKey": "My-Product",
"status": "REQUESTED",
"subStatus": "PENDING_CREATE",
"sharedCustomerId": "19c9dafb-c000-4000-8abb-231782b4b101",
"timeline": {
"activatedTs": "1970-01-01T00:00:00.000Z",
"createFailedTs": "1970-01-01T00:00:00.000Z",
"createRequestedTs": "1970-01-01T00:00:00.000Z",
"createdTs": "1970-01-01T00:00:00.000Z",
"terminatedTs": "1970-01-01T00:00:00.000Z"
},
"source": {
"brand": "My Brand",
"channelType": "Website",
"country": "GB",
"region": "Cambridgeshire"
},
"activation": {
"activationCode": "string",
"activationUrl": "string",
"activationUrlExpiryTs": "1970-01-01T00:00:00.000Z"
}
}
]
}
]{
"message": "Bad Request",
"statusCode": 400
}{
"message": "Not found",
"statusCode": 404
}{
"message": "Internal server error",
"statusCode": 500
}Search Consumer Offer
Search consumer offers.
POST
/
consumerOffers
/
search
Search Consumer Offer
curl --request POST \
--url https://api.example.com/consumerOffers/search \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"consumer": {
"consumerIdentifier": "6X3D5MHHVSRGKDRLCHIC3Q2W2AQE55BK"
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({consumer: {consumerIdentifier: '6X3D5MHHVSRGKDRLCHIC3Q2W2AQE55BK'}})
};
fetch('https://api.example.com/consumerOffers/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.example.com/consumerOffers/search"
payload = { "consumer": { "consumerIdentifier": "6X3D5MHHVSRGKDRLCHIC3Q2W2AQE55BK" } }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)[
{
"consumerOffer": {
"consumerOfferId": "338d31e1-a289-40dd-beff-ab41c1fc5f51",
"offerId": "7560fca0-d8a9-4124-a172-924debec874e",
"consumer": {
"consumerIdentifier": "6X3D5MHHVSRGKDRLCHIC3Q2W2AQE55BK",
"billingIdentifier": "RDZN22AAVYAHVDN3N2OB2A7ADA3FVQWG",
"communicationInformation": {
"emailAddress": "example@bango.com",
"msisdn": "+441234567890"
}
},
"status": "REQUESTED",
"subStatus": "PENDING_CREATES",
"timeline": {
"createRequestedTs": "1970-01-01T00:00:00.000Z",
"createdTs": "1970-01-01T00:00:00.000Z",
"createsFailedTs": "1970-01-01T00:00:00.000Z",
"entitlementsRequestedTs": "1970-01-01T00:00:00.000Z",
"terminateRequestedTs": "1970-01-01T00:00:00.000Z"
}
},
"entitlements": [
{
"entitlementId": "b0163d06-1fa3-4c9b-a298-29635ca7151d",
"merchantAccountKey": "MY_CONTENT_PROVIDER",
"productKey": "My-Product",
"status": "REQUESTED",
"subStatus": "PENDING_CREATE",
"sharedCustomerId": "19c9dafb-c000-4000-8abb-231782b4b101",
"timeline": {
"activatedTs": "1970-01-01T00:00:00.000Z",
"createFailedTs": "1970-01-01T00:00:00.000Z",
"createRequestedTs": "1970-01-01T00:00:00.000Z",
"createdTs": "1970-01-01T00:00:00.000Z",
"terminatedTs": "1970-01-01T00:00:00.000Z"
},
"source": {
"brand": "My Brand",
"channelType": "Website",
"country": "GB",
"region": "Cambridgeshire"
},
"activation": {
"activationCode": "string",
"activationUrl": "string",
"activationUrlExpiryTs": "1970-01-01T00:00:00.000Z"
}
}
]
}
]{
"message": "Bad Request",
"statusCode": 400
}{
"message": "Not found",
"statusCode": 404
}{
"message": "Internal server error",
"statusCode": 500
}Authorizations
HTTPBasicOAuth2PasswordBearer
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Consumer offer search criteria.
Filter search by this consumer.
Show child attributes
Show child attributes
Filter search by this consumer offer status.
FULLY_CREATED: all entitlements have been createdFULLY_ACTIVE: all entitlements are activeFULLY_TERMINATED: all entitlements have been terminated
Available options:
FULLY_CREATED, FULLY_ACTIVE, FULLY_TERMINATED 
