Collectible Listings

What are Listings?

When you own a collectible, one or multiple editions of it, you can decide to create a listing to sale them via the ORB Marketplace. This allows other users who are interested in owning these collectibles, to fulfill these listings, buy the collectibles, against the price you have set.

List your first Collectible

Use the following mutation to create a listing for a Collectible in ORB.

CreateListing
mutation CreateListing($input: CreateCollectionInput!) {
  CreateCollection(input: $input) {
    state
    transactionHash
  }
}
Input Variables
"input": {
    "collectionId": "KT1AcxKcwf5bdNfwY6qYMVFjx4mGVftLThP2",
    "editions": 5,
    "expiryTime": "1700642468",
    "listingPrice": 100,
    "tokenId": "2"
 }

In terms of the input variables of the mutation, here are a few tips to help you understand the process:

  • collectionId: This is the collectionId of the collectible on which this mutation will have an effect on. More specifically, this is the collectionId under which you have created your collectible, which you wish to list for sale.

  • editions: This is the number of editions of this Collectible you want to list for sale. This number needs to be less than or equal to the number of editions you currently own. If not, the mutation will throw an error.

  • expiryTime: This is the time that the listing will expire. The format of this input needs to be in epoch. Here is a very handy date time to epoch converter, to help you with this input parameter.

  • listingPrice: This is the price you wish to list your Collectible for. The input reflects the price per edition of the Collectible.

  • tokenId: This is the tokenId of the collectible on which this mutation will have an effect on.

Once you call the mutation, you will receive the following transaction. Upon signing the transaction, the collectible will be listed in the ORB Marketplace.

Sample Response
{
  "data": {
    "CreateListing": {
      "state": "operation_response",
      "transactionHash": "op8Ee1n4uyRBvYi1YFwEazw4uBH3qoYPrZtvr42NaMmQv45JQ84"
    }
  }
}

Once the transaction has been signed from the developer, a listing for the editions of the collectible will be created in the ORB Platform. This means that a user will be able to fulfill this listing and buy your one or all editions of the collectibles you have listed. Along with the listing on the Marketplace, a unique identifier will also be created, which will accompany the listing until it is either fulfilled or retracted from the Marketplace.

Fulfill a Listing

Use the following mutation to fulfill a listing in ORB.

FulfillListing
mutation FulfillListing($input: FulFillListingInput!) {
  FulfillListing(input: $input) {
    state
    transactionHash
  }
}
Input Variables
"input": {
    "Amount": 5,
    "ListId": "2"
 }

In terms of the input variables of the mutation, here are a few tips to help you understand the process:

  • ListId: This is the ListId of the listing on which this mutation will have an effect on.

  • Amount: This is the price that the listing will be fulfilled with. Essentially, this is the price that the buyer will pay in order to purchase the collectible currently listed for sale.

Once you call the mutation, you will receive the following transaction. Upon signing the transaction, the collectible will be sold, and the listing fulfilled.

Sample Response
{
  "data": {
    "FulfillListing": {
      "state": "applied",
      "transactionHash": "opC2d7YNYCgGRApPnP5vUX7LeuLrkkHz62ER2uvu9FWymau7Xa2"
    }
  }
}

Once the transaction has been signed from the developer, the listing will be removed from the ORB Marketplace. This means that the user who created the listing will receive the price for which the collectible was sold for, and the buyer will receive the Collectible.

Retract a Listing

In case you wish to change any of the inputs you have previously included in a collectible listing, or you simple want to remove a listing you have created, you can always retract the listing from the Marketplace. Once retracted, you can create a new one.

Use the following mutation to retract a listing in ORB.

RetractListing
mutation RetractListing($input: RetractListingInput!) {
  RetractListing(input: $input) {
    state
    transactionHash
  }
}
Input Variables
"input": {
    "ListId": "9"
 }

In terms of the input variables of the mutation, here are a few tips to help you understand the process:

  • ListId: This is the ListId of the listing on which this mutation will have an effect on.

  • Amount: This is the price that the listing will be fulfilled with. Essentially, this is the price that the buyer will pay in order to purchase the collectible currently listed for sale.

Once you call the mutation, you will receive the following transaction. Upon signing the transaction, the listing will be retracted from the ORB Marketplace immediately.

Sample Response
{
  "data": {
    "RetractListing": {
      "state": "applied",
      "transactionHash": "opC2d7YNYCgGRApPnP5vUX7LeuLrkkHz62ER2uvu9FWymau7Xa2"
    }
  }
}

Once the transaction has been signed from the developer, the listing will be removed from the ORB Marketplace.

When selling or buying a collectible from the ORB Marketplace, that is $ORB infused, remember that the $ORB tokes will follow the collectible throughout its lifecycle. Meaning, if you buy an $ORB infused collectible, the $ORB tokens will continue to be infused in the collectible.

PreviousMarketplace FunctionsNextCollectible Offers

Last updated