Gift With Purchase API

Retrieve GWP and details

GEThttps://tyviso.com/gwp/api?partner={ID}&market={market}

Parameters

Name	Description	Type
partner	Your unique ID, identifying you as publisher	String
market	Your market target	String

Tyviso will provide your unique ID, which is entered in the URL above.

JSON get data example

This is an example of how to get GWP with every option included.


          {
            "header": {
              "title": String,
              "description": String,
              "hideGiftCounter": Boolean,
              "titleBold": Boolean,
              "rotate": Boolean,
              "hideSticker": Boolean,
              "sticker": Int
            },
            "banner": {
              "title": "String",
              "description": "String",
            },
            "settings": {
              "footerText": "String",
              "ctaBg": "String",
              "selectedColor: "String"
            },
            "rewards": Offer[]
          }

Rewards API

Retrieve rewards and details

GEThttps://tyviso.com/rewards/api?partner={ID}

Parameters

Name	Description	Type
partner	Your unique ID, identifying you as publisher	String

Tyviso will provide your unique ID, which is entered in the URL above.

JSON get data example

This is an example of how to get rewards with every option included.


          {
            "template": Int(1) || Int(2) || Int(3) || Int(4),
            "headerTemplate": Int(1) || Int(2),
            "header": {
              "title": "String",
              "description": "String",
              "steps": [
                {
                  "text": "String",
                  "img": "String"
                },
                {
                  "text": "String",
                  "img": "String"
                },
                {
                  "text": "String",
                  "img": "String"
                }
              ],
              "hideHeader": "Boolean"
            },
            "settings": {
              "ctaLabel": "String",
              "ctaColor": "String",
              "ctaBg": "String",
              "headerBg": "String",
              "headerTextColor": "String",
              "terms": "String",
              "notWorking": "Boolean",
              "customCss": "String",
              "bottomArrows": "Boolean"
            },
            "offers": {
              "hero": [Offer?],                    // maximum one offer
              "popular": [Offer?, Offer?, Offer?],   // maximum of 3 offers
              "all": Offer[]
            }
          }

JSON Offer data

Here is the template for the offer's payload


          {
            id: String,
            partner: String,
            terms: String,
            url: String,
            title: String,
            description: String,
            image: String,
            squareImage: String,
            offerInfoButtonDiscount: String,
            offerInfoButtonDescription: String,
            offerInfoButtonCta: String,
            offerDiscountCode: String,
            offerDiscountCodeType: String,
            cta: String
          }

Gift After Purchase API

Retrieve GAP and details

GEThttps://tyviso.com/gap/api?partner={ID}

Parameters

Name	Description	Type
partner	Your unique ID, identifying you as publisher	String

Tyviso will provide your unique ID, which is entered in the URL above.

JSON get data example

This is an example of how to get rewards with every option included.


          {
            "template": Int(1) || Int(2) || Int(3) || Int(4),
            "headerTemplate": Int(1) || Int(2),
            "header": {
              "title": "String",
              "description": "String",
              "steps": [
                {
                  "text": "String",
                  "img": "String"
                },
                {
                  "text": "String",
                  "img": "String"
                },
                {
                  "text": "String",
                  "img": "String"
                }
              ],
              "hideHeader": "Boolean"
            },
            "settings": {
              "ctaLabel": "String",
              "ctaColor": "String",
              "ctaBg": "String",
              "headerBg": "String",
              "headerTextColor": "String",
              "terms": "String",
              "notWorking": "Boolean",
              "customCss": "String",
              "bottomArrows": "Boolean"
            },
            "rewards": Offer[]
          }

JSON Offer data

Here is the template for the offer's payload


          {
            id: String,
            partner: String,
            terms: String,
            url: String,
            title: String,
            description: String,
            image: String,
            squareImage: String,
            offerInfoButtonDiscount: String,
            offerInfoButtonDescription: String,
            offerInfoButtonCta: String,
            offerDiscountCode: String,
            offerDiscountCodeType: String,
            cta: String
          }