Giftoin Docs
  • ๐Ÿ‘‹INTRODUCTION
    • Welcome to Giftoin
    • Overview
    • Quick Start
    • FAQs
    • Key Features
  • ๐ŸงฉAPI REFERENCE
    • Standards and Conventions
    • Orders API
      • Tokens/Points
      • Collectibles/Cards
      • Collectibles/Random Cards
    • Users API
      • Inventory
      • Progress
    • Error Handling
  • ๐Ÿ’ปPLATFORM GUIDES
    • Roblox
      • Why use Giftoin?
      • Basic Usage
      • Developer Access
      • Installation
      • Additional Example / Use-Cases
        • Point Reward
        • Daily Reward
        • Advanced Point Distribution System
        • Managed Codes & In-Game Rewards (Coming Soon)
          • Registering Reward Types
      • Tools and Scripts
        • Rotating Script
        • Floating Script
        • Quest System (Coming Soon)
    • Discord
      • Introduction
      • Getting Started
      • Command Reference
      • Role System
      • User Guides
      • Troubleshooting
      • FAQs
    • Wordpress
  • ๐Ÿ“šResources
    • Use Cases
      • Basic
      • eCommerce
      • Games
    • Support
Powered by GitBook
On this page

Was this helpful?

  1. API REFERENCE
  2. Orders API

Collectibles/Cards

PreviousTokens/PointsNextCollectibles/Random Cards

Last updated 3 months ago

Was this helpful?

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.

๐Ÿงฉ

Create Collectibles Campaign Order

post

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

Authorizations
Path parameters
campaignCollectiblesIdstringRequired

The unique identifier for the collectibles campaign

Example: campaign_456
Body
contactsstring ยท email[]Required

Recipients of the order as email addresses

Example: recipient@example.com
titlestringOptional

Optional title for the order

Example: Winter Collection Reward
descriptionstringOptional

Optional description for the order

Example: Reward for completing the challenge
Responses
201
Order created successfully
application/json
400
Bad Request - Missing or invalid parameters
application/json
401
Unauthorized - API key is missing or invalid
application/json
404
Campaign not found
application/json
post
POST /api/v1/gcm/reseller/campaign/{campaignCollectiblesId}/order HTTP/1.1
Host: api.giftoin.org
x-gft_api_key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 258

{
  "contacts": [
    "recipient@example.com"
  ],
  "thirdPartyUserIds": [
    {
      "type": "discord",
      "id": "123456789012345678"
    }
  ],
  "title": "Winter Collection Reward",
  "description": "Reward for completing the challenge",
  "metadata": {
    "source": "winter_promotion",
    "department": "marketing"
  }
}
{
  "orderId": "order_12345",
  "status": "created"
}