Socios.com Connect
Chiliz ChainChiliz Labs
  • Socios.com Connect
  • INTERACT WITH CHILIZ CHAIN
    • Overview
    • Prerequisites
    • Working with Tokens
    • Working with NFTs
    • Working with Transactions
    • Working with Polls
    • Working with Staking
  • Partner API
    • Overview
    • 2025 API Update Overview
    • Prerequisites
    • Quick start
    • Authentication
    • API Reference
      • Data API
        • Data API endpoints
      • NFT API
        • NFT API endpoints
      • Ping API
      • Polls API
        • Polls API endpoints
      • Rewards API
        • Rewards API endpoints
      • User API
        • User API endpoints
      • Wallet API
        • Wallet API endpoints
  • Partner web app
    • Overview
    • Integration
    • URL parameters
    • On-Ramp Fan Tokens
Powered by GitBook
On this page
  1. Partner API
  2. API Reference
  3. Rewards API

Rewards API endpoints

PreviousRewards APINextUser API

Last updated 10 months ago

Endpoint to get all fan shop rewards filtered by partnerIds

get
Authorizations
Query parameters
categoryIds[]string[]OptionalDefault: []
partnerIds[]string[]OptionalDefault: []
productTypeIds[]string[]OptionalDefault: []
sports[]string[]OptionalDefault: []
countries[]string[]OptionalDefault: []
statuses[]string[]OptionalDefault: []
Responses
200
Success
application/json
404
Entity not found
application/json
500
Internal Server Error
application/json
get
GET /rewards/1.0.0/rewards HTTP/1.1
Host: api-public.socios.com
Accept: */*
{
  "data": [
    {
      "id": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
      "name": "Signed jersey",
      "description": "Signed jersey description",
      "sellingPrice": "20.5",
      "partnerId": "cf7a5894-ac9d-4157-8998-e0eaa80b0bc0",
      "maxUserPurchase": 2,
      "canUserUseProductTierLevel": true,
      "redeemType": "regular",
      "publishedAt": "2023-07-27T14:24:09+00:00",
      "productTierLevel": {
        "id": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
        "name": "Tier I",
        "minTokenRequired": 2,
        "createdAt": "2023-07-27T14:24:09+00:00",
        "updatedAt": "2023-07-27T14:24:09+00:00"
      },
      "categories": [
        {
          "id": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
          "name": "Club rewards",
          "status": "enabled"
        }
      ],
      "productType": [
        {
          "id": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
          "name": "Generic Physical"
        }
      ],
      "productVariant": [
        {
          "id": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
          "label": "Signed jersey size M",
          "status": "enabled",
          "availableStock": 2,
          "redeemableAt": "1690467849",
          "place": "stadium",
          "seatSection": "home",
          "size": "XXS",
          "color": "red",
          "edition": "signed",
          "gender": "male",
          "eventDate": "1690467849",
          "createdAt": "1690467849",
          "updatedAt": "1690467849",
          "assets": [
            {
              "url": "https://url.com/partner/d66eb9d2-56c6-4b1b-8f56-31f8aa319abe/partner_logo/38aca876-86a8-4a10-a0e8-b0859614c8b3.png?version=1653577420",
              "type": "jpg",
              "format": "mobile",
              "width": "500",
              "height": "500"
            }
          ]
        }
      ],
      "tags": [
        {
          "id": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
          "name": "Club rewards",
          "status": "enabled"
        }
      ],
      "assets": [
        {
          "url": "https://url.com/partner/d66eb9d2-56c6-4b1b-8f56-31f8aa319abe/partner_logo/38aca876-86a8-4a10-a0e8-b0859614c8b3.png?version=1653577420",
          "type": "jpg",
          "format": "mobile",
          "width": "500",
          "height": "500"
        }
      ],
      "totalUserProductPurchases": 2,
      "createdAt": "2023-07-27T14:24:09+00:00",
      "updatedAt": "2023-07-27T14:24:09+00:00",
      "sportType": [
        {
          "id": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
          "name": "Footbal"
        }
      ],
      "country": {
        "id": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
        "name": "Italy"
      }
    }
  ]
}

Endpoint to get all fan shop reward categories

get
Authorizations
Query parameters
partnerIds[]string[]OptionalDefault: []
productTypeIds[]string[]OptionalDefault: []
sports[]string[]OptionalDefault: []
countries[]string[]OptionalDefault: []
statuses[]string[]OptionalDefault: []
Responses
200
Success
application/json
404
Entity not found
application/json
500
Internal Server Error
application/json
get
GET /rewards/1.0.0/reward-categories HTTP/1.1
Host: api-public.socios.com
Accept: */*
{
  "data": [
    {
      "id": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
      "name": "Club rewards",
      "status": "enabled",
      "parentCategoryId": "63967271-a6f3-40bc-b431-f4df86ad37e5",
      "color": "#9F2B68",
      "createdAt": "2023-07-27T14:24:09+00:00",
      "updatedAt": "2023-07-27T14:24:09+00:00"
    }
  ]
}

Get details of a single reward

get
Authorizations
Path parameters
rewardIdstringRequired
Responses
200
Success
application/json
404
Entity not found
application/json
500
Internal Server Error
application/json
get
GET /rewards/1.0.0/rewards/{rewardId} HTTP/1.1
Host: api-public.socios.com
Accept: */*
{
  "data": {
    "id": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
    "name": "Signed jersey",
    "description": "Signed jersey description",
    "sellingPrice": "20.5",
    "partnerId": "cf7a5894-ac9d-4157-8998-e0eaa80b0bc0",
    "maxUserPurchase": 2,
    "canUserUseProductTierLevel": true,
    "redeemType": "regular",
    "publishedAt": "2023-07-27T14:24:09+00:00",
    "productTierLevel": {
      "id": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
      "name": "Tier I",
      "minTokenRequired": 2,
      "createdAt": "2023-07-27T14:24:09+00:00",
      "updatedAt": "2023-07-27T14:24:09+00:00"
    },
    "categories": [
      {
        "id": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
        "name": "Club rewards",
        "status": "enabled"
      }
    ],
    "productType": [
      {
        "id": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
        "name": "Generic Physical"
      }
    ],
    "productVariant": [
      {
        "id": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
        "label": "Signed jersey size M",
        "status": "enabled",
        "availableStock": 2,
        "redeemableAt": "1690467849",
        "place": "stadium",
        "seatSection": "home",
        "size": "XXS",
        "color": "red",
        "edition": "signed",
        "gender": "male",
        "eventDate": "1690467849",
        "createdAt": "1690467849",
        "updatedAt": "1690467849",
        "assets": [
          {
            "url": "https://url.com/partner/d66eb9d2-56c6-4b1b-8f56-31f8aa319abe/partner_logo/38aca876-86a8-4a10-a0e8-b0859614c8b3.png?version=1653577420",
            "type": "jpg",
            "format": "mobile",
            "width": "500",
            "height": "500"
          }
        ]
      }
    ],
    "tags": [
      {
        "id": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
        "name": "Club rewards",
        "status": "enabled"
      }
    ],
    "assets": [
      {
        "url": "https://url.com/partner/d66eb9d2-56c6-4b1b-8f56-31f8aa319abe/partner_logo/38aca876-86a8-4a10-a0e8-b0859614c8b3.png?version=1653577420",
        "type": "jpg",
        "format": "mobile",
        "width": "500",
        "height": "500"
      }
    ],
    "totalUserProductPurchases": 2,
    "createdAt": "2023-07-27T14:24:09+00:00",
    "updatedAt": "2023-07-27T14:24:09+00:00"
  }
}
  • GETEndpoint to get all fan shop rewards filtered by partnerIds
  • GETEndpoint to get all fan shop reward categories
  • GETGet details of a single reward