Collectibles/Random Cards

Create Random Collectibles Campaign Order

post

Creates a new order for a random collectibles campaign. This endpoint is used when you want to award random collectibles to recipients.

Authorizations

Path parameters

campaignRandomIdstringRequired

The unique identifier for the random collectibles campaign

Example: campaign_456

Body

contactsstring · email[]Required

Recipients of the order as email addresses

Example: [e-mail]

titlestringOptional

Optional title for the order

Example: Mystery Card Reward

descriptionstringOptional

Optional description for the order

Example: Random card from our new collection

metadataobjectOptional

The 'metadata' field allows you to store up to 10 custom key-value pairs with the order. This is useful for tracking information like order source, internal reference IDs, department codes, or any other custom attributes needed for integration with your systems.

Example: {"source":"winter_promotion","department":"marketing"}

Responses

application/json

objectOptional

Response from creating an order

application/json

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/gcm/reseller/campaign/{campaignRandomId}/order HTTP/1.1
Host: api.giftoin.org
x-gft_api_key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "contacts": [
    "[e-mail]"
  ],
  "title": "Mystery Card Reward",
  "description": "Random card from our new collection",
  "metadata": {
    "source": "winter_promotion",
    "department": "marketing"
  }
}

{
  "orderId": "order_12345",
  "status": "created"
}

API Reference Notice

We are currently experiencing a technical issue with the API reference display in GitBook. For the most accurate and complete API documentation, please refer to our official API reference on Postman.

We apologize for any inconvenience and are working to resolve this issue. Thank you for your understanding.