Overview
What's New
Web Store
- Player Authentication
- Offers
- Offers V1 API
- Introduction
- POSTCreate Offer
- PUTUpdate Offer
- DELDelete Offer
- POSTGet Offer
- Rolling Offer V1 API
- Popups V1 API
- Offers V2 API
- Personalization
- Webhooks
Checkout
- Checkout Session
- Orders
- Finance and Analytics
- Checkout Webhooks
Events Center
- Introduction
- Login Events
- Store Interaction Events
- Error Events
- Order Events
- Refund and Dispute Events
Offers V1 API
Get Offer
POST
/
offering
/
offer
/
get-offers
Copy
curl --request POST \
--url https://api-sandbox.appcharge.com/offering/offer/get-offers \
--header 'x-publisher-token: <x-publisher-token>'
Copy
{
"result": {
"totalCount": 123,
"offers": [
{
"offerId": "<string>",
"publisherOfferId": "<string>",
"name": "<string>",
"displayName": "<string>",
"description": "<string>",
"type": "<string>",
"createdBy": "<string>",
"offerUi": {
"offerUiId": "<string>",
"externalId": "<string>",
"active": true,
"offerUiType": "<string>",
"name": "<string>",
"description": "<string>",
"backgroundImage": "<string>",
"specialOffer": {
"templateType": "<string>",
"presentOfferEndTimer": true,
"title": "<string>",
"fontSize": 123,
"fontWeight": "<string>",
"fontColor": {
"colorOne": "<string>",
"colorTwo": "<string>",
"direction": "<string>"
},
"backgroundColor": {
"colorOne": "<string>",
"colorTwo": "<string>",
"direction": "<string>"
}
}
},
"dynamicOfferUi": {
"badges": [
{
"publisherBadgeId": "<string>",
"position": "<string>"
}
],
"salePercentage": 123,
"salePercentageDisplayType": "percentage"
},
"active": true,
"segments": [
"<string>"
],
"productsSequence": [
{
"index": 123,
"playerAvailability": 123,
"priceInUsdCents": 123,
"products": [
{
"quantity": 123,
"product": {
"publisherProductId": "<string>",
"name": "<string>",
"textFontColorHex": "<string>",
"type": "<string>",
"prefix": "<string>",
"suffix": "<string>",
"priority": "<string>",
"images": [
{
"type": "<string>",
"url": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"productId": "<string>"
}
}
]
}
],
"startOver": true,
"priority": 123,
"showAfter": "<string>",
"triggers": [
{
"type": "<string>",
"eventName": "<string>",
"every": 123,
"rules": [
"<any>"
]
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
},
"status": 123,
"message": "<string>"
}
Headers
The publisher token
Query Parameters
Bundle, SpecialOffer, Popup
Record limit (0-500). Defaults to 100 if not defined.
Required range:
0 <= x <= 500
Offset (non-negative value).
Required range:
x >= 0
To retrieve specific offers. If adding multiple, use ',' to separate.
Response
200
application/json
Get all offers
The response is of type object
.
Was this page helpful?
Copy
curl --request POST \
--url https://api-sandbox.appcharge.com/offering/offer/get-offers \
--header 'x-publisher-token: <x-publisher-token>'
Copy
{
"result": {
"totalCount": 123,
"offers": [
{
"offerId": "<string>",
"publisherOfferId": "<string>",
"name": "<string>",
"displayName": "<string>",
"description": "<string>",
"type": "<string>",
"createdBy": "<string>",
"offerUi": {
"offerUiId": "<string>",
"externalId": "<string>",
"active": true,
"offerUiType": "<string>",
"name": "<string>",
"description": "<string>",
"backgroundImage": "<string>",
"specialOffer": {
"templateType": "<string>",
"presentOfferEndTimer": true,
"title": "<string>",
"fontSize": 123,
"fontWeight": "<string>",
"fontColor": {
"colorOne": "<string>",
"colorTwo": "<string>",
"direction": "<string>"
},
"backgroundColor": {
"colorOne": "<string>",
"colorTwo": "<string>",
"direction": "<string>"
}
}
},
"dynamicOfferUi": {
"badges": [
{
"publisherBadgeId": "<string>",
"position": "<string>"
}
],
"salePercentage": 123,
"salePercentageDisplayType": "percentage"
},
"active": true,
"segments": [
"<string>"
],
"productsSequence": [
{
"index": 123,
"playerAvailability": 123,
"priceInUsdCents": 123,
"products": [
{
"quantity": 123,
"product": {
"publisherProductId": "<string>",
"name": "<string>",
"textFontColorHex": "<string>",
"type": "<string>",
"prefix": "<string>",
"suffix": "<string>",
"priority": "<string>",
"images": [
{
"type": "<string>",
"url": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"productId": "<string>"
}
}
]
}
],
"startOver": true,
"priority": 123,
"showAfter": "<string>",
"triggers": [
{
"type": "<string>",
"eventName": "<string>",
"every": 123,
"rules": [
"<any>"
]
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
},
"status": 123,
"message": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.