🪙Cashback

Good to know: The order type is based on the campaign. You can easily know the type of your campaign by entering the campaign details page on the management dashboard.

There are generally two types of orders:

1. The amount of the coins are fixed. For example, each one of the orders will send a giftoin that contain X amount of the coin.

2. The amount of the coins are dynamic. Can be used for cashback campaigns. For example, each one of the order will send a giftoin that potentially can have different amount of the coin. For order #1 the amount of the coin will be X and for order #2 it can be Y.

Creating orders

Create a new order under campaign

Must send either contacts, contactsPhone, or both

post

/v1/gcm/reseller/campaign/{campaignId}/order

Authorizations

Path parameters

campaignIdstringrequired

ID of the campaign you wish to create new order for

Header parameters

x-gft_api_keystringrequired

Platform API key

Body

one of

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.giftoin.org/api/v1/gcm/reseller/campaign/{campaignId}/order' \
  --header 'x-gft_api_key: text' \
  --header 'Content-Type: application/json' \
  --data '{"contacts":["[e-mail]"],"contactsPhone":[12312322334]}'

200

429

200

{
  "data": {
    "orderId": "2qAPc7lzpT4UIRESMXgb"
  }
}

success response

Code Example - Fixed Order

cURL

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.giftoin.org/api/v1/gcm/reseller/campaign/<your-campaign-id>/order',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "contacts": [
        "[e-mail]"
    ],
    "title": "Order title",
    "description": "Order description"
}',
  CURLOPT_HTTPHEADER => array(
    'x-gft_api_key: <your-api-key>',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

NodeJS - Axios

const axios = require('axios');
let data = JSON.stringify({
  "contacts": [
    "[e-mail]"
  ],
  "title": "Order title",
  "description": "Order description"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.giftoin.org/api/v1/gcm/reseller/campaign/<your-campaign-id>/order',
  headers: { 
    'x-gft_api_key': '<your-api-key>', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

PHP - cURL

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.giftoin.org/api/v1/gcm/reseller/campaign/<your-campaign-id>/order',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "contacts": [
        "[e-mail]"
    ],
    "title": "Order title",
    "description": "Order description"
}',
  CURLOPT_HTTPHEADER => array(
    'x-gft_api_key: <your-api-key>',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Code Example - Dynamic Order (Cashback)

cURL

curl --location 'https://api.giftoin.org/api/v1/gcm/reseller/campaign/<your-campaign-id>/order' \
--header 'x-gft_api_key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "contacts": [
        "[e-mail]"
    ],
    "coins": [
        {
            "id": 1,
            "valueInUSD": 1
        }
    ],
    "title": "Order title",
    "description": "Order description"
}'

NodeJS - Axios

const axios = require('axios');
let data = JSON.stringify({
  "contacts": [
    "[e-mail]"
  ],
  "coins": [
    {
      "id": 1,
      "valueInUSD": 1
    }
  ],
  "title": "Order title",
  "description": "Order description"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.giftoin.org/api/v1/gcm/reseller/campaign/<your-campaign-id>/order',
  headers: { 
    'x-gft_api_key': '<your-api-key>', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

PHP - cURL

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.giftoin.org/api/v1/gcm/reseller/campaign/<your-campaign-id>/order',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "contacts": [
        "[e-mail]"
    ],
    "coins": [
        {
            "id": 1,
            "valueInUSD": 1
        }
    ],
    "title": "Order title",
    "description": "Order description"
}',
  CURLOPT_HTTPHEADER => array(
    'x-gft_api_key: <your-api-key>',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;