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

collectionName*string

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.

mintMode*enum

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.

serialrandom

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.

pendingfailed

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)

Request

const response = await fetch('/v1/item-types', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "collectionName": "collectionName",
      "maxSupply": 1000,
      "mintMode": "serial",
      "defaultMetadata": {
        "name": "itemName",
        "description": "<p>itemDescription</p>",
        "image": "http://url.com/image",
        "attributes": [
          {
            "type": "attribute1",
            "value": 10,
            "displayType": "number",
            "maxValue": 100
          },
          {
            "type": "attribute2",
            "value": "value",
            "displayType": "string"
          }
        ],
        "__$markdownParsed": true
      }
    }),
});
const data = await response.json();

Response

{
  "id": "f4e5d3a4-2a9b-4d9f-bc5a-73b3f0c47b5e",
  "state": "pending",
  "collectionName": "collectionName",
  "maxSupply": 1000,
  "issuedSupply": 0,
  "circulatingSupply": 0,
  "mintMode": "serial",
  "defaultMetadata": {
    "name": "itemName",
    "description": "<p>itemDescription</p>",
    "image": "http://url.com/image",
    "attributes": [
      {
        "type": "attribute1",
        "value": 10,
        "displayType": "number",
        "maxValue": 100
      },
      {
        "type": "attribute2",
        "value": "value",
        "displayType": "string"
      }
    ],
    "__$markdownParsed": true
  }
}

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, and pagination of results when querying a list of item types.

idsarray of string (uuid)

An array of items type ids to search for.

collectionNamesarray of string (string)

An array of collection names to find the matching item types for

statesarray of string (string)

The current blockchain state of the item type(s) that you are searching for

mintModesarray of string (string)

The mint mode (serial, random, etc) of the item type(s) that you are searching for

limitstring

The maximum number of items you would like returned in this search

Example: "10"

skipstring

How many records should be skipped in the result set before returning results?

Example: "10"

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.

pendingfailed

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)

Request

const response = await fetch('/v1/item-types/search', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "mintModes": [
        "serial"
      ],
      "limit": 100,
      "skip": 0
    }),
});
const data = await response.json();

Response

[
  {
    "id": "f4e5d3a4-2a9b-4d9f-bc5a-73b3f0c47b5e",
    "state": "pending",
    "collectionName": "collectionName",
    "maxSupply": 1000,
    "issuedSupply": 0,
    "circulatingSupply": 0,
    "mintMode": "serial",
    "defaultMetadata": {
      "name": "itemName",
      "description": "<p>itemDescription</p>",
      "image": "http://url.com/image",
      "attributes": [
        {
          "type": "attribute1",
          "value": 10,
          "displayType": "number",
          "maxValue": 100
        },
        {
          "type": "attribute2",
          "value": "value",
          "displayType": "string"
        }
      ],
      "__$markdownParsed": true
    }
  }
]

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.

pendingfailed

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)

Request

const response = await fetch('/v1/item-types/{itemTypeId}', {
    method: 'GET',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();

Response

{
  "id": "f4e5d3a4-2a9b-4d9f-bc5a-73b3f0c47b5e",
  "state": "pending",
  "collectionName": "collectionName",
  "maxSupply": 1000,
  "issuedSupply": 0,
  "circulatingSupply": 0,
  "mintMode": "serial",
  "defaultMetadata": {
    "name": "itemName",
    "description": "<p>itemDescription</p>",
    "image": "http://url.com/image",
    "attributes": [
      {
        "type": "attribute1",
        "value": 10,
        "displayType": "number",
        "maxValue": 100
      },
      {
        "type": "attribute2",
        "value": "value",
        "displayType": "string"
      }
    ],
    "__$markdownParsed": true
  }
}

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.

pendingfailed

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)

Request

const response = await fetch('/v1/item-types/{itemTypeId}', {
    method: 'PUT',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "f4e5d3a4-2a9b-4d9f-bc5a-73b3f0c47b5e",
  "state": "pending",
  "collectionName": "collectionName",
  "maxSupply": 1000,
  "issuedSupply": 0,
  "circulatingSupply": 0,
  "mintMode": "serial",
  "defaultMetadata": {
    "name": "itemName",
    "description": "<p>itemDescription</p>",
    "image": "http://url.com/image",
    "attributes": [
      {
        "type": "attribute1",
        "value": 10,
        "displayType": "number",
        "maxValue": 100
      },
      {
        "type": "attribute2",
        "value": "value",
        "displayType": "string"
      }
    ],
    "__$markdownParsed": true
  }
}

PreviousPlayers NextItems

Last updated 3 months ago

const response = await fetch('/v1/item-types/{itemTypeId}', { method: 'GET', headers: { "Authorization": "text", "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000" }, }); const data = await response.json();

{ "id": "f4e5d3a4-2a9b-4d9f-bc5a-73b3f0c47b5e", "state": "pending", "collectionName": "collectionName", "maxSupply": 1000, "issuedSupply": 0, "circulatingSupply": 0, "mintMode": "serial", "defaultMetadata": { "name": "itemName", "description": "itemDescription", "image": "http://url.com/image", "attributes": [ { "type": "attribute1", "value": 10, "displayType": "number", "maxValue": 100 }, { "type": "attribute2", "value": "value", "displayType": "string" } ], "__$markdownParsed": true } }

const response = await fetch('/v1/item-types', { method: 'POST', headers: { "Authorization": "text", "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000", "Content-Type": "application/json" }, body: JSON.stringify({ "collectionName": "collectionName", "maxSupply": 1000, "mintMode": "serial", "defaultMetadata": { "name": "itemName", "description": "itemDescription", "image": "http://url.com/image", "attributes": [ { "type": "attribute1", "value": 10, "displayType": "number", "maxValue": 100 }, { "type": "attribute2", "value": "value", "displayType": "string" } ], "__$markdownParsed": true } }), }); const data = await response.json();

const response = await fetch('/v1/item-types/{itemTypeId}', { method: 'PUT', headers: { "Authorization": "text", "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000", "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();

const response = await fetch('/v1/item-types/search', { method: 'POST', headers: { "Authorization": "text", "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000", "Content-Type": "application/json" }, body: JSON.stringify({ "mintModes": [ "serial" ], "limit": 100, "skip": 0 }), }); const data = await response.json();

[ { "id": "f4e5d3a4-2a9b-4d9f-bc5a-73b3f0c47b5e", "state": "pending", "collectionName": "collectionName", "maxSupply": 1000, "issuedSupply": 0, "circulatingSupply": 0, "mintMode": "serial", "defaultMetadata": { "name": "itemName", "description": "itemDescription", "image": "http://url.com/image", "attributes": [ { "type": "attribute1", "value": 10, "displayType": "number", "maxValue": 100 }, { "type": "attribute2", "value": "value", "displayType": "string" } ], "__$markdownParsed": true } } ]