LogoLogo
Back to AppHelp Center
  • Getting Started
    • Welcome
  • OrdinalsBot API
    • Overview
    • Libraries
    • Template-App
    • Signet
    • Testnet
    • Fractal
    • Getting Prices
      • Getting Prices (Legacy)
    • Create a Direct Inscription Order
    • Create a Managed Inscription Order
    • Get Order Status
    • Create a Collection
    • Create a Collection Order
    • Create Text Inscription Order
    • Search Inscriptions
    • Check Rare Sats Inventory
    • Referral Scheme
    • Transaction Accelerator
    • Burning Assets
    • Webhooks
    • Order States
    • Order Types
  • Runes
    • Etch
    • Mint
    • Launchpad
      • Create
      • Mint
      • Get Launchpad
    • Airdrop
  • Token Pay
    • What is TokenPay?
    • API Docs
      • API reference
        • Order
        • Create payment psbt
        • Create burn rune psbt
        • Validate burn rune tx
        • Create burn inscription psbt
        • Utils
          • Checktx
          • Submittx
          • Finalize psbt
        • User
          • Withdrawal
          • Order
            • Rune
          • Account
            • Withdraw
            • Balance
      • Specification
  • Marketplace
    • User Guide: Pre-Inscribed Launchpad API
    • API Docs
    • Editions Launchpad
  • Launchpad API
    • Create Marketplace
    • Create a new Launchpad
    • Retrieve Launch PSBT
    • Confirm Launch
    • Check Allocation
    • Check for Padding Outputs
    • Setup Padding Outputs
    • Create buy offer
    • Confirm buy offer
    • Get Launch Info
  • Sat Scanner API
    • Find Special Ranges
    • Find Special Ranges UTXO
    • Supported Satributes
  • Sat Extractor
    • Extract
  • BRC20 API
    • OPI API
  • SNS API
    • SNS API
  • Mempool API
    • Mempool API
  • TAP PROTOCOL
    • Tap Reader API
  • UTXO
    • Split
  • User Guide
    • Inscribe your first Ordinal
    • Receiving Payments
  • Knowledge Base
    • Ordinals
      • What is an Ordinal?
      • Satoshi Rarity
      • What are BRC-20 Tokens?
      • Image Optimisation
      • Pixel Art
    • Bitcoin
      • Unspent Transaction Output (UTXO)
  • Official Links
    • Twitter
    • Discord
Powered by GitBook
On this page
  1. OrdinalsBot API

Order States

Every order has a consistent state field. That is the only correct way to check the progress of your order. The possible order states are the following:

const WAITING_PAYMENT = 'waiting-payment'; // order is waiting for a payment to be detected
const WAITING_CONFIRMATION = 'waiting-confirmation'; // payment is detected, waiting for confirmations
const WAITING_PARENT = 'waiting-parent'; // order is waiting for the parent inscription to hit the wallet
const PREP = 'prep'; // order files are being downloaded
const QUEUED = 'queued'; // order is queued for inscription
const ERROR = 'error'; // order has an error
const CANCELED = 'cancelled'; // order is cancelled
const WAITING_REFUND = 'waiting-refund'; // collection order is waiting refund
const REFUNDED = 'refunded'; // collection order was refunded
const EXPIRED = 'expired'; // open node invoice expired
const WAITING_REVEAL = 'waiting-reveal'; // order is waiting to broadcast the inscription reveal
const WAITING_RUNE_BALANCE = 'waiting-rune-balance'; // order is waiting for the rune balance to confirm
const COMPLETED = 'completed'; // order is complted, files are inscribed

PreviousWebhooksNextOrder Types

Last updated 1 year ago