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
    },
    "stock": {
      "totalCount": 0,
      "keys": [
        {
          "keyId": 0,
          "hash": "string",
          "value": "string",
          "status": 0,
          "created": "string",
          "soldAt": "string",
          "cogs": 0,
          "format": "text"
        }
      ]
    }
  }
}

400

{
    "message": "Bad Request. Wrong/Invalid params format.",
    "statusCode": 400 
}

401

{
    "message": "UnAuthorized request. Invalid/Expired token",
    "statusCode": 401
}

403

{
    "message": "Forbidden Request. Action not allowed or Rate Limit exhausted.", 
    "statusCode": 403
}

500

{
    "message": "Internal Server Error",
    "statusCode": 500
}