Card/Coupon

Use this endpoint to send users gifts

Create a new order under campaign

Must send either contacts, contactsPhone, or both

POSThttps://api.giftoin.org/api/v1/gcm/reseller/campaign/{campaignId}/order

Authorization

api_key

Path parameters

campaignId*string

ID of the campaign you wish to create new order for

Header parameters

Body

application/json

campaignId_order_body (one of)

object

Response

200429

success response

Body

application/json

datainline_response_200_2_data (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.giftoin.org/api/v1/gcm/reseller/campaign/{campaignId}/order', {
    method: 'POST',
    headers: {
      "x-gft_api_key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "contacts": [
        "[e-mail]"
      ]
    }),
});
const data = await response.json();

Response

200429

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

API Error Codes

Our API returns specific error codes to indicate the nature of errors encountered during API requests. Each error code is accompanied by a detailed message to help diagnose and resolve issues. Below is a list of known error codes, their meanings, and recommended actions.

Error Response Structure

When an error occurs, the API returns a JSON response with the following structure:

{
    "status": {
        "timestamp": 1717595028825,
        "errorCode": 5250,
        "errorMessage": "Campaign not found"
    }
}

• timestamp: The time at which the error occurred (in milliseconds since epoch).

• errorCode: A unique code representing the specific error.

• errorMessage: A descriptive message explaining the error.

Known Error Codes

Error Code	Error Title	Error Message
5250	CAMPAIGN_NOT_FOUND	Campaign not found
5255	CAMPAIGN_LIMITED_QUANTITY_OUT_OF_STOCK	Campaign out of stock
5257	CAMPAIGN_USER_INSTANCE_RECEIVE_LIMIT_REACHED	One of the users have reached the allowed limit for receiving instances of the campaign.