Skip to content
DonutStatsAPI
Sign up
Object

Order

One open buy order.

Deliveries to orders are recorded as they happen, which is how fills and paid out totals are measured.

Returned by

GETList buy ordersGETGet an item

Fields

  • idinteger

    Stable id of the buy order.

  • productProduct

    What the order wants to buy.

    Show6 child fields
    • keystring

      Unique product key: the item id, plus the variant in square brackets when there is one. Examples: diamond, elytra[mending,unbreaking:3], potion[poison]. Use it with product= filters and /v1/items/{key}.

    • itemstring

      Minecraft item id without the minecraft: namespace, for example netherite_sword. Many products can share one item id.

    • namestring

      Display name, for example Potion of Poison.

    • variantstring

      What sets this product apart from the plain item. Empty for plain items. See variants for the rules.

    • categorystring | null

      One of combat, tools, valuables, drops, food, potions, blocks or misc.

    • detailsProductDetails | null

      Structured extras such as enchantments, shulker box contents or a custom name.

      Show5 child fields
      • enchantmentsEnchantment[]

        Enchantments on the item itself, sorted by id. Left out when there are none.

        Show2 child fields
        • idstring

          Enchantment id without the minecraft: namespace, for example sharpness.

        • levelinteger

          Enchantment level, starting at 1.

      • storedEnchantmentsEnchantment[]

        Enchantments stored in an enchanted book. Left out for every other item.

        Show2 child fields
        • idstring

          Enchantment id without the minecraft: namespace, for example sharpness.

        • levelinteger

          Enchantment level, starting at 1.

      • contentsContainerEntry[]

        What a shulker box holds, one entry per item id with counts added together, largest first.

        Show2 child fields
        • itemstring

          Item id, for example netherite_sword.

        • countinteger

          Total number of that item in the box.

      • customNamestring

        The name shown in game when it differs from the default item name. DonutSMP renames some items, for example Dried Ghast on a skeleton skull.

      • flightDurationinteger

        Flight duration of a firework rocket, from 1 to 3.

  • unitPricenumber

    What the order pays per item delivered.

  • amountinteger

    Total number of items the order asks for.

  • deliveredinteger

    Items delivered so far.

  • remaininginteger

    Items still wanted: amount minus delivered.

  • firstSeenAttimestamp

    When the order first appeared.

  • lastSeenAttimestamp

    When the order was last confirmed open.

  • progressedAttimestamp | null

    When a delivery to this order was last recorded. null if none yet.

  • marketPricenumber | null

    Current market price of the product.