Campaigns

Don't forget: You must include your API key with every API call, otherwise you will receive an error.

Get a single campaign

GEThttps://api.giftoin.org/api/v1/gcm/reseller/{campaignId}

Authorization

api_key

Path parameters

campaignId*string

ID of the campaign you wish to create new order for

Header parameters

Response

200

success response

Body

application/json

datainline_response_200_1_data (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.giftoin.org/api/v1/gcm/reseller/{campaignId}', {
    method: 'GET',
    headers: {
      "x-gft_api_key": "text"
    },
});
const data = await response.json();

Response

200

{
  "data": {
    "campaign": {
      "name": "March Campaign",
      "description": "March Campaign"
    },
    "giftoin": {
      "name": "Cinema Gift",
      "message": "Thanks for being a loyal customer!",
      "senderName": "Giftoin's Cinema"
    },
    "assets": [
      {
        "name": "Free Popcorn",
        "description": "Display this on the counter and claim your free popcorn!",
        "image": "https://giftoin-prod.infura-ipfs.io/ipfs/QmUn1XXUbfqzpVe4JycBv6AVLLBjYNCaeZo1tudgGq3MiM",
        "type": "coupon"
      }
    ]
  }
}

There are two types of assets. Card and Coupon.

Response Data Drilldown

Campaign

All of the campaign's data is only for the administrator view. Used to easily to differentiate between different campaigns. For example, a campaign used when a customer purchase on the online marketplace vs physical purchase in the store.

Giftoin

The end-user data for the user. Info about the gift that is wrapping the assets.

Giftoin Data In End User Application (1)

Giftoin Data In End User Application (2)

Assets

List of items that are included inside the gift. Currently can be either a card or coupon . The data is shown differently to the end-user, depends on the type of the asset.

Coupon

Card