Get Single Offer

Updated: 06th June 2024

This API gets the details for a single offer/auction & a paginated list of the stocks/keys available.

Supported arguments

The following arguments are supported by this API:

GET /offers/{id}

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Params

Param	Param Type	Type	Required	Description
id	path	number	Yes	Id of the Offer
search	query	string	No	Search for a Key in this offer
page	query	number	No	Page number. Default value: 1
limit	query	number	No	Number of items per page. Default value: 10
filter	query	string	No	Filter keys. Supported values: inactive, live, sold, def - defective

Response

200

{
  "message": "string",
  "statusCode": 200,
  "data": {
    "pages": 0,
    "offer": {
      "offerId": 0,
      "slug": "string",
      "title": "string",
      "countryRestrictions": "string",
      "languages": "string",
      "description": "string",
      "platform": "string",
      "productImage": "string",
      "yourPrice": "string",
      "commission": "number",
      "createdAt": "string",
      "updatedAt": "string",
      "lastUpdate": "string",
      "status": 0,
      "productStatus": 0,
      "productId": 0,
      "regionId": "string",
      "storeId": 0,
      "productType": "string",
      "minPrice": "string",
      "totalInActive": 0,
      "totalAvailable": 0,
      "totalDeclaredStock": 0,
      "declaredStockReservedKeys": 0,
      "inventoryReservedKeys": 0,
      "totalSold": 0,
      "totalDefective": 0,
      "price": {
        "yourPrice": 5,
        "retailPrice": 5.46
      },
      "automatePriceOptions": {
        "automatePriceStatus": "disable",
        "lowerPriceLimit": 1.71,
        "higherPriceLimit": 8.36,
        "priceChangeInterval": 300,
        "priceChangeFactor": 0.01
      },
      "formFields": [
        {
          "name": "userid",
          "type": "string"
        },
        {
          "name": "device",
          "type": "enum",
          "value": "android | ios"
        }
      ]
    },
    "stock": {
      "totalCount": 0,
      "keys": [
        {
          "keyId": 0,
          "hash": "string",
          "value": "string",
          "status": 0,
          "created": "string",
          "soldAt": "string",
          "cogs": 0,
          "format": "text"
        }
      ]
    },
    "wholesale": {
      "enabled": true,
      "tiers": [
        {
          "discount": 10,
          "level": 1,
          "yourPrice": 135,
          "retailPrice": 136.36,
          "levelRange": "10 to 99 Keys"
        },
        {
          "discount": 15,
          "level": 2,
          "yourPrice": 127.5,
          "retailPrice": 128.14,
          "levelRange": "100+ Keys"
        }
      ]
    }
  }
}

400

401

403

500

Conditional Notes

1. Top-up Products (productType: "topup") Direct Topup Webhook

• formFields: ✅ Present

  • Required inputs from the user (e.g., userid, device)

  • type can be "string" or "enum"

  • value defined only for enum types

  {
    "name": "device",
    "type": "enum",
    "value": "android | ios"
  }

• wholesale: ❌ Not present

• stock: ❌ Not present

---

2. Digital Key / Standard Products (productType: "game")

• formFields: ❌ Not present

• wholesale: ✅ Present if bulk pricing is enabled ( see Wholesale Pricing Feature )

• stock: ✅ Present with key metadata

---

3. Price & Automate Options

• price.yourPrice → Seller price

• price.retailPrice → Platform retail price

• automatePriceOptions → Rules for auto price adjustment

---

Example Summary Table

Product Type	formFields	wholesale	stock
Top-up Product	✅	❌	❌
Digital Key	❌	✅	✅