WoW:API GetInboxInvoiceInfo: Difference between revisions
Jump to navigation
Jump to search
(Added basic API description) |
m (Move page script moved page API GetInboxInvoiceInfo to API GetInboxInvoiceInfo without leaving a redirect) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{wowapi}} | |||
invoiceType, itemName, playerName, bid, buyout, deposit, consignment = GetInboxInvoiceInfo(index); | invoiceType, itemName, playerName, bid, buyout, deposit, consignment = GetInboxInvoiceInfo(index); | ||
| Line 16: | Line 16: | ||
invoiceType, itemName, playerName, bid, buyout, deposit, consignment | invoiceType, itemName, playerName, bid, buyout, deposit, consignment | ||
:;invoiceType : String - type of invoice ("buyer" | :;invoiceType : String - type of invoice ("buyer", "seller", or "seller_temp_invoice"). | ||
:;itemName : String - The name of the item sold/bought. | :;itemName : String - The name of the item sold/bought. | ||
:;playerName : Boolean - The player that sold/bought the item. | :;playerName : Boolean - The player that sold/bought the item. | ||
| Line 22: | Line 22: | ||
:;buyout : Number - The amount of money set as buyout for the auction. | :;buyout : Number - The amount of money set as buyout for the auction. | ||
:;deposit : Number - The amount paid as deposit for the auction. | :;deposit : Number - The amount paid as deposit for the auction. | ||
:;consignment : Number - The | :;consignment : Number - The fee charged by the auction house for selling your consignment. | ||
==Notes== | |||
Patch 2.1 introduced a 1 hour delay on payment messages from the auction house, and in the meantime a message with subject "Sale Pending: [item name]" is sent to you with a 1 hour expiry. Although the message in the blizzard UI only shows the amount pending, the message can be queried with GetInboxInvoiceInfo() to determine the bid, buyout, deposit and consignment fee amounts, which can then be used to calculate the amount pending. This is useful, since GetInboxHeaderInfo() for that message (correctly) reports 0 money attached. | |||
Latest revision as of 04:45, 15 August 2023
← WoW API < GetInboxInvoiceInfo
invoiceType, itemName, playerName, bid, buyout, deposit, consignment = GetInboxInvoiceInfo(index);
Returns information about an auction house invoice.
- Arguments
- (index)
- index
- Number - the index of the message (1 is the first message)
- Returns
invoiceType, itemName, playerName, bid, buyout, deposit, consignment
- invoiceType
- String - type of invoice ("buyer", "seller", or "seller_temp_invoice").
- itemName
- String - The name of the item sold/bought.
- playerName
- Boolean - The player that sold/bought the item.
- bid
- Number - The amount of money bid on the item.
- buyout
- Number - The amount of money set as buyout for the auction.
- deposit
- Number - The amount paid as deposit for the auction.
- consignment
- Number - The fee charged by the auction house for selling your consignment.
Notes[edit]
Patch 2.1 introduced a 1 hour delay on payment messages from the auction house, and in the meantime a message with subject "Sale Pending: [item name]" is sent to you with a 1 hour expiry. Although the message in the blizzard UI only shows the amount pending, the message can be queried with GetInboxInvoiceInfo() to determine the bid, buyout, deposit and consignment fee amounts, which can then be used to calculate the amount pending. This is useful, since GetInboxHeaderInfo() for that message (correctly) reports 0 money attached.