Item Types

Create an item type

Creating an item type means a collection will be deployed on-chain, from which items (NFTs) are minted when using the POST /items endpoint. An item type requires valid default metadata in order to be deployed.

POST/v1/item-types

Header parameters

Body

The item type to be created

collectionNamestring

The name of the collection on-chain. This is a unique identifier which helps ensure you're looking at the right asset on the block explorer. It's not displayed in the Mythical Marketplace. This is immutable.

maxSupplyinteger

The maximum quantity of the item which can be granted.

mintModeenum

Describes how the tokenId is chosen when new items are minted.

serial: Each consecutive tokenId is incremented from the previous.
random: Each consecutive tokenId is a random number between 1 and the maxSupply.
controlled: The tokenId is input by the studio when the item is minted.

serialrandomcontrolled

defaultMetadataItemMetadata (object)

Response

Success

Body

idstring (uuid)

Unique identifier of the item type

stateenum

Describes the state of the item type

pending: Awaiting deployment of the collection to finalize on-chain.
failed: Deployment of the collection failed to finalize on-chain.
deployed: The collection is deployed on-chain.
started: Items can be minted.
ended: Items can no longer be minted.

pendingfaileddeployedstartedended

collectionNamestring

maxSupplyinteger

The maximum quantity of the item which can be granted.

issuedSupplyinteger

The quantity of items which have been granted.

circulatingSupplyinteger

The quantity of items which have been granted, minus the quantity of items that have been burned.

mintModeenum

Describes how the tokenId is chosen when new items are minted.

serial: Each consecutive tokenId is incremented from the previous.
random: Each consecutive tokenId is a random number between 1 and the maxSupply.
controlled: The tokenId is input by the studio when the item is minted.

serialrandomcontrolled

defaultMetadataItemMetadata (object)

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "state": "pending",
  "collectionName": "text",
  "mintMode": "serial",
  "defaultMetadata": {
    "name": "text",
    "description": "text",
    "image": "text",
    "attributes": [
      {
        "type": "string",
        "value": "attrValue",
        "displayType": "number, boolean, string",
        "maxValue": 255
      }
    ]
  }
}

Search item types

Retrieve a list of item types. Supports filtering, sorting, and pagination.

POST/v1/item-types/search

Header parameters

Body

Defines the structure of a search request. Allows for filtering, sorting, and pagination of results when querying a list of items. The filter property specifies the criteria used to filter the data, sort defines the order in which the results should be returned, and pagination controls the number of results returned and the starting point within the dataset.

filterobject

sortobject

paginationobject

Response

Success

Body

idstring (uuid)

Unique identifier of the item type

stateenum

Describes the state of the item type

pending: Awaiting deployment of the collection to finalize on-chain.
failed: Deployment of the collection failed to finalize on-chain.
deployed: The collection is deployed on-chain.
started: Items can be minted.
ended: Items can no longer be minted.

pendingfaileddeployedstartedended

collectionNamestring

maxSupplyinteger

The maximum quantity of the item which can be granted.

issuedSupplyinteger

The quantity of items which have been granted.

circulatingSupplyinteger

The quantity of items which have been granted, minus the quantity of items that have been burned.

mintModeenum

Describes how the tokenId is chosen when new items are minted.

serial: Each consecutive tokenId is incremented from the previous.
random: Each consecutive tokenId is a random number between 1 and the maxSupply.
controlled: The tokenId is input by the studio when the item is minted.

serialrandomcontrolled

defaultMetadataItemMetadata (object)

Response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "state": "pending",
    "collectionName": "text",
    "mintMode": "serial",
    "defaultMetadata": {
      "name": "text",
      "description": "text",
      "image": "text",
      "attributes": [
        {
          "type": "string",
          "value": "attrValue",
          "displayType": "number, boolean, string",
          "maxValue": 255
        }
      ]
    }
  }
]

Get an item type by item type id

Retrieve a single item type by id.

GET/v1/item-types/{itemTypeId}

Path parameters

itemTypeId*string

Header parameters

Response

Success

Body

idstring (uuid)

Unique identifier of the item type

stateenum

Describes the state of the item type

pending: Awaiting deployment of the collection to finalize on-chain.
failed: Deployment of the collection failed to finalize on-chain.
deployed: The collection is deployed on-chain.
started: Items can be minted.
ended: Items can no longer be minted.

pendingfaileddeployedstartedended

collectionNamestring

maxSupplyinteger

The maximum quantity of the item which can be granted.

issuedSupplyinteger

The quantity of items which have been granted.

circulatingSupplyinteger

The quantity of items which have been granted, minus the quantity of items that have been burned.

mintModeenum

Describes how the tokenId is chosen when new items are minted.

serial: Each consecutive tokenId is incremented from the previous.
random: Each consecutive tokenId is a random number between 1 and the maxSupply.
controlled: The tokenId is input by the studio when the item is minted.

serialrandomcontrolled

defaultMetadataItemMetadata (object)

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "state": "pending",
  "collectionName": "text",
  "mintMode": "serial",
  "defaultMetadata": {
    "name": "text",
    "description": "text",
    "image": "text",
    "attributes": [
      {
        "type": "string",
        "value": "attrValue",
        "displayType": "number, boolean, string",
        "maxValue": 255
      }
    ]
  }
}

Update an item type

Update the mutable attributes of an item type.

PUT/v1/item-types/{itemTypeId}

Path parameters

itemTypeId*string

Header parameters

Body

Updates to be made to the item type

defaultMetadataItemMetadata (object)

Response

Success

Body

idstring (uuid)

Unique identifier of the item type

stateenum

Describes the state of the item type

pending: Awaiting deployment of the collection to finalize on-chain.
failed: Deployment of the collection failed to finalize on-chain.
deployed: The collection is deployed on-chain.
started: Items can be minted.
ended: Items can no longer be minted.

pendingfaileddeployedstartedended

collectionNamestring

maxSupplyinteger

The maximum quantity of the item which can be granted.

issuedSupplyinteger

The quantity of items which have been granted.

circulatingSupplyinteger

The quantity of items which have been granted, minus the quantity of items that have been burned.

mintModeenum

Describes how the tokenId is chosen when new items are minted.

serial: Each consecutive tokenId is incremented from the previous.
random: Each consecutive tokenId is a random number between 1 and the maxSupply.
controlled: The tokenId is input by the studio when the item is minted.

serialrandomcontrolled

defaultMetadataItemMetadata (object)

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "state": "pending",
  "collectionName": "text",
  "mintMode": "serial",
  "defaultMetadata": {
    "name": "text",
    "description": "text",
    "image": "text",
    "attributes": [
      {
        "type": "string",
        "value": "attrValue",
        "displayType": "number, boolean, string",
        "maxValue": 255
      }
    ]
  }
}

PreviousPlayers NextItems

Last updated 1 month ago

{ "id": "123e4567-e89b-12d3-a456-426614174000", "state": "pending", "collectionName": "text", "mintMode": "serial", "defaultMetadata": { "name": "text", "description": "text", "image": "text", "attributes": [ { "type": "string", "value": "attrValue", "displayType": "number, boolean, string", "maxValue": 255 } ] } }

[ { "id": "123e4567-e89b-12d3-a456-426614174000", "state": "pending", "collectionName": "text", "mintMode": "serial", "defaultMetadata": { "name": "text", "description": "text", "image": "text", "attributes": [ { "type": "string", "value": "attrValue", "displayType": "number, boolean, string", "maxValue": 255 } ] } } ]