collectionItemByClaimCode

This query loads the information of collection with listing based on the claim code.

Note:-

isRedeemedCode status indicates whether the given claim code was used or not.

Sample query

query collectionItemByClaimCode($claimCode: String!) {
  collectionItemByClaimCode(claimCode: $claimCode) {
    lot {
      id
      __typename
    }
    id
    marketplaceTokenId
    collectionId
    saleType
    name
    description
    status
    slug
    isBallot
    totalQuantity
    perWalletMaxClaim
    numberOfCodes
    prefix
    allowedClaimingMethod
    allowList {
      id
      __typename
    }
    asset {
      id
      versions {
        id
        name
        cdnUrl
        assetID
        __typename
      }
      currentVersion {
        id
        name
        cdnUrl
        assetID
        __typename
      }
      __typename
    }
    details {
      ... on MarketplaceAuctionLot {
        id
        lotNumber
        marketplaceCollectionItemId
        startingBid
        reservePrice
        previewDate
        startDate
        endDate
        status
        currentBid {
          id
          isCurrent
          amount
          createdAt
          deletedAt
          marketplaceAuctionLotId
          nextBidIncrement
          currentBid
          userId
          maximumBid
          claimRebateAmount
          walletAddress
          claimStatus
          auctionEndDate
          marketplaceUser {
            id
            username
            __typename
          }
          __typename
        }
        bids {
          id
          isCurrent
          amount
          createdAt
          deletedAt
          marketplaceAuctionLotId
          nextBidIncrement
          currentBid
          userId
          maximumBid
          claimRebateAmount
          walletAddress
          claimStatus
          auctionEndDate
          marketplaceUser {
            id
            username
            __typename
          }
          __typename
        }
        myBid {
          id
          isCurrent
          amount
          createdAt
          deletedAt
          marketplaceAuctionLotId
          nextBidIncrement
          currentBid
          userId
          maximumBid
          claimRebateAmount
          walletAddress
          claimStatus
          auctionEndDate
          marketplaceUser {
            id
            username
            __typename
          }
          __typename
        }
        marketplaceAuctionOnChainSettings {
          id
          marketplaceAuctionLotID
          nftContractAddress
          tokenID
          quantityOf1155
          tokenOwnerAddress
          startingBidCryptoPrice
          reservedPrice
          paymentCurrency
          whitelistedBuyers
          blacklistedBuyers
          paymentSettlementAddress
          taxSettlementAddress
          commissionAddress
          platformSettlementAddress
          commissionFeePercentage
          platformFeePercentage
          createAuctionJobStatus
          endAuctionStatus
          cancelAuctionStatus
          networkID
          endTransactionHash
          tokenType
          supportedCurrencyID
          halfLifeTime
          availableQuantity
          totalQuantity
          reduceByAmount
          reduceByInterval
          walletLimit
          transactionLimit
          isInstantDelivery
          fromTokenID
          toTokenID
          rebateEnabled
          rebateStatus
          minimumBidCryptoPrice
          isMint
          maxTokenIDRange
          isCollectionLevelAuction
          onChainAuctionContractAddress
          AuctionContractVersion {
            id
            contractABIFileURL
            __typename
          }
          updateAuctionJobStatus
          __typename
        }
        feeStructure {
          buyersPremiumRate {
            from
            to
            rate
            __typename
          }
          overheadPremiumRate {
            from
            to
            rate
            __typename
          }
          __typename
        }
        isOnchainAuction
        maxEndDate
        subSaleType
        isOnchainAuction
        enableAutoExtension
        lastIntervalMinutes
        extensionMinutes
        maxDuration
        __typename
      }
      ... on MarketplaceBuyNowOutput {
        id
        unitPrice
        totalUnits
        totalAvailableUnits
        startDate
        endDate
        sortNumber
        configuration {
          walletLimitPerAddress
          transactionLimitPerAddress
          allowListLimitPerAddress
          __typename
        }
        onchainBuynowContractExtensionStatus
        onchainBuynowContractApprovalStatus
        buynowContractVersion {
          contractABIFileURL
          contractAddress
          __typename
        }
        onchainBuynowCancelSaleStatus
        onchainBuynowSaleCreationStatus
        onchainBuynowSaleCreationTxhash
        __typename
      }
      ... on MarketplaceClaimableOutput {
        id
        totalUnits
        perWalletLimit
        startDate
        endDate
        claimingType
        totalAvailableUnits
        isOnchainClaim
        totalAvailableUnits
        __typename
      }
      __typename
    }
    isOnchain
    paymentCurrencyId
    isCreditCardPayment
    onChainPaymentInfo {
      platformFeePercentage
      commissionFeePercentage
      commissionAddress
      taxSettlementAddress
      paymentSettlementAddress
      platformSettlementAddress
      onchainPaymentAddress
      __typename
    }
    supportedCurrency {
      symbol
      id
      isCurrencyFiat
      __typename
    }
    NFTDetails {
      tokenStatus
      contractAddress
      collectionName
      nftTokenId
      tokenType
      tokenId
      tokenName
      editions
      contractId
      invoiceItemID
      isDelivered
      __typename
    }
    gatingGroup {
      id
      groupName
      __typename
    }
    isReserved
    isRedeemedCode
    __typename
  }
}

Sample variable

{
  "claimCode": "SAK"
}

Sample response

{
  "data": {
    "collectionItemByClaimCode": {
      "lot": {
        "id": "00000000-0000-0000-0000-000000000000",
        "__typename": "MarketplaceAuctionLot"
      },
      "id": "50824c42-1596-46fd-93fe-b3f2f54296a7",
      "marketplaceTokenId": null,
      "collectionId": "775015fe-bc27-48b9-9702-dd4ba3b59741",
      "saleType": "Claimable",
      "name": "TEST claim 1",
      "description": "",
      "status": "Active",
      "slug": "test-claim-1",
      "isBallot": false,
      "totalQuantity": 1,
      "perWalletMaxClaim": 1,
      "numberOfCodes": 1,
      "prefix": "SAK",
      "allowedClaimingMethod": "SingleCode",
      "allowList": null,
      "asset": {
        "id": "62a7042b-2b6d-4f27-ae09-fa02878ac8bc",
        "versions": [
          {
            "id": "8bd6af94-a3a7-4f09-9e52-c3ae3fcb8365",
            "name": "surya-nair-surya-1-2.jpg",
            "cdnUrl": "https://storage.googleapis.com/mojito-dev-public/organizations/8d95625a-5848-440c-8e55-0d008c9a1d38/images/62a7042b-2b6d-4f27-ae09-fa02878ac8bc.jpg?z=1",
            "assetID": "62a7042b-2b6d-4f27-ae09-fa02878ac8bc",
            "__typename": "AssetVersion"
          }
        ],
        "currentVersion": {
          "id": "8bd6af94-a3a7-4f09-9e52-c3ae3fcb8365",
          "name": "surya-nair-surya-1-2.jpg",
          "cdnUrl": "https://storage.googleapis.com/mojito-dev-public/organizations/8d95625a-5848-440c-8e55-0d008c9a1d38/images/62a7042b-2b6d-4f27-ae09-fa02878ac8bc.jpg?z=1",
          "assetID": "62a7042b-2b6d-4f27-ae09-fa02878ac8bc",
          "__typename": "AssetVersion"
        },
        "__typename": "Asset"
      },
      "details": {
        "id": "1a34a844-26a5-4c01-b66d-387b8de7f8e1",
        "totalUnits": 1,
        "perWalletLimit": 1,
        "startDate": "2024-06-26T06:09:39Z",
        "endDate": "2024-06-27T22:51:21Z",
        "claimingType": "SingleCode",
        "totalAvailableUnits": 0,
        "isOnchainClaim": false,
        "__typename": "MarketplaceClaimableOutput"
      },
      "deliveryMethod": "ERC721Transfer",
      "isOnchain": false,
      "paymentCurrencyId": null,
      "isCreditCardPayment": false,
      "onChainPaymentInfo": null,
      "supportedCurrency": null,
      "NFTDetails": [
        {
          "tokenStatus": "MINTED",
          "contractAddress": "0x6f2fffafad2ab6c256e36d675bc6a8b0d5985f19",
          "collectionName": "TEST BASE CONTRACT",
          "nftTokenId": "02fc089e-b4cc-44c5-8262-5b07ae247cc7",
          "tokenType": "ERC721",
          "tokenId": "1",
          "tokenName": "Base Test Token #1",
          "editions": 1,
          "contractId": "9b3c0e15-f0b5-404e-abf4-0eea0810c9e3",
          "invoiceItemID": "bd7dafb3-5da6-4fd9-b3e2-32ecda79ddee",
          "isDelivered": false,
          "__typename": "CollectionNFTDetails"
        }
      ],
      "gatingGroup": null,
      "isReserved": false,
      "isRedeemedCode": true,
      "__typename": "MarketplaceCollectionItem"
    }
  }
}

Arguments

NameTypeDescriptionRequired
codeStringClaim Code created for the SaleYes

Fields

NameTypeDescription
MarketplaceCollectionItemObjectContains the information from MarketplaceCollectionItem including ID, marketplace token ID, collection ID, sale type, collection name, slug, collection status, and details.