Skip to main content
GET
/
v1
/
products
/
{id}
Get Product
curl --request GET \
  --url https://dev.api.mufi.app/v1/products/{id} \
  --header 'Authorization: Bearer <token>'
{
  "type": "admission",
  "name": "<string>",
  "event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "event": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "start_date": 123,
    "end_date": 123,
    "location": "<string>",
    "address": "<string>",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reference_id": "<string>",
    "description": "<string>"
  },
  "description": "<string>",
  "price": "<string>",
  "active": true,
  "is_claimable": true,
  "is_transferable": true,
  "stock": 2,
  "redemption_quantity": 2,
  "max_per_account": 2,
  "min_rep_balance": 1,
  "metadata_uri": "<string>",
  "mint_nft": true,
  "chain": "WestendAssetHub",
  "max_items": 2
}

Authorizations

​
Authorization
string
header
required

A JWT Access Token obtained from Google Cloud.

Path Parameters

​
id
string<uuid>
required

The product ID.

Response

The product record.

​
type
enum<string>
required
Available options:
admission,
presale,
perks
​
name
string
required

The name of the product.

Required string length: 1 - 255
​
event_id
string<uuid>
required

The ID of the event that the product is associated with. Leave blank for a general product that lives longer than an event.

​
id
string<uuid>
required

The ID of the product.

​
created_at
string<date-time>
required

The date and time the product was created.

​
updated_at
string<date-time>
required

The date and time the product was last updated.

​
event
object
required
​
description
string | null

The description of the product.

Required string length: 1 - 255
​
price
string | null

The price of the product as a decimal string (e.g. "9.99"). Defaults to "0".

​
active
boolean | null

Whether the product is active and available. Defaults to true.

​
is_claimable
boolean | null

Whether the product can be claimed via a direct URL. Defaults to false.

​
is_transferable
boolean | null

Whether product items can be transferred between users. Defaults to false.

​
stock
integer | null

Total stock available. Null or omit for unlimited stock.

Required range: x >= 1
​
redemption_quantity
integer | null

How many times a single product item can be redeemed. Defaults to 1.

Required range: x >= 1
​
max_per_account
integer | null

Maximum number of items a single user can hold. Null or omit for unlimited.

Required range: x >= 1
​
min_rep_balance
integer | null

Minimum reputation balance required to receive this product. Defaults to 0.

Required range: x >= 0
​
metadata_uri
string<uri> | null

The URL of the metadata for the asset containing name, image, description fields. Required if mint_nft is true.

Maximum string length: 512
​
mint_nft
boolean | null

Whether to mint an NFT when a user receives a product item. If true, the metadata_uri must be provided.

​
chain
enum<string>

The chain to mint the NFT on. Required if mint_nft is true.

Available options:
WestendAssetHub,
AssetHub
​
max_items
number | null

The maximum number of items that can be in the asset collection. Leave blank for an unlimited number of items.

Required range: x >= 1