When you request information from the StampWants API, you will receive a response in the form of a csv file. Depending on what type of information you request, the csv file will contain different fields. This page defines the fields you will receive from the StampWants API, depending on which type of information you request.
| Field Name
| Value Type
| Description
|
| ID
| Integer (StampWants ID)
| The StampWants ID number of the listing.
|
| Private ID
| Text
| The Private ID you set for this listing, if set.
|
| Title
| Text
| The Title of the listing.
|
| Description
| Text
| The Description of the listing. Note: If the Description is over 16,000 characters, only the first 16,000 characters are displayed.
|
| Starting Bid
| Decimal
| The Starting Bid of the listing. Note: If the listing is a Fixed Price listing, or Store Item, the Starting Bid will be equal to the Buy It Now Price.
|
| Buy It Now Price
| Decimal
| The Buy It Now Price of the listing.
|
| Reserve Price
| Decimal
| The Reserve Price of the listing.
|
| Listing Type
| standard, store or public
| If the listing is either an auction or fixed price listing, the value of this field will be 'standard'. If the listing is a store item, the value of this field will be 'store'. If the listing is either a Public Auction or Mail Sale listing, the value of this field will be 'public'.
|
| Duration
| 1,3,5,7,10 or 30
| The duration of the listing. Note: Store Items will display '30' even though they do not end, because listing fees are charged every 30 days.
|
| Original Quantity
| Integer
| The original quantity available, as indicated for the listing.
|
| Quantity Available
| Integer
| The current quantity available for the listing.
|
| Category ID
| Integer Number (a valid Category Code, as found on the Category Code page)
| The Category Code of the main category of the listing.
|
| Additional Category ID
| Integer Number (a valid Category Code, as found on the Category Code page)
| The Category Code of the additional category of the listing.
|
| Image URL
| URL
| The URL to the image associated with this listing. Note: Only the first image associated with the listing is returned.
|
| Max Bid
| Decimal
| The current max bid of the listing, if a bid has been placed.
|
| Number of Bids
| Integer
| The number of bids placed on this listing.
|
| Start Date
| Date (YYYY-MM-DD HH:MM:SS)
| The date the listing started, in EST/EDT.
|
| End Date
| Date (YYYY-MM-DD HH:MM:SS)
| The date the listing ends, in EST/EDT.
|
| Currency
| ARS, AUD, BRL, CAD, CHF, CLP, CNY, COP, CZK, DKK, EUR, FJD, GBP, HKD, IDR, ILS, INR, INR, JPY, KRW, LKR, MAD, MXN, MYR, NOK, NZD, PAB, PEN, PHP, PKR, PLN, RUR, SEK, SGD, SIT, SKK, THB, TND, TRL, TWD, USD, VEB or ZAR
| The currency the item is listed in.
|
| Sale Percent
| Decimal
| If the item is currently on sale, the percent off will be displayed (e.g. 10.00 for an item on sale for 10% off).
|
| Field Name
| Value Type
| Description
|
| ID
| Integer (StampWants ID)
| The StampWants ID of this listing.
|
| Private ID
| Text
| The Private ID you set for this listing, if set.
|
| Title
| Text
| The Title of the listing.
|
| Amount
| Decimal
| The amount the listing sold for in this specific transaction.
|
| Quantity
| Integer
| The quantity of this particular listing sold in this specific transaction. Note: This will be 1 unless the listing had a multiple quantity.
|
| Starting Bid
| Decimal
| The Starting Bid of the listing. Note: If the listing is a Fixed Price listing, or Store Item, the Starting Bid will be equal to the Buy It Now Price.
|
| Buy It Now Price
| Decimal
| The Buy It Now Price of the listing.
|
| Reserve Price
| Decimal
| The Reserve Price of the listing.
|
| Listing Type
| standard, store or public
| If the listing is either an auction or fixed price listing, the value of this field will be 'standard'. If the listing is a store item, the value of this field will be 'store'. If the listing is either a Public Auction or Mail Sale listing, the value of this field will be 'public'.
|
| Duration
| 1,3,5,7,10 or 30
| The duration of the listing. Note: Store Items will display '30' even though they do not end, because listing fees are charged every 30 days.
|
| Category ID
| Integer Number (a valid Category Code, as found on the Category Code page)
| The Category Code of the main category of the listing.
|
| Additional Category ID
| Integer Number (a valid Category Code, as found on the Category Code page)
| The Category Code of the additional category of the listing.
|
| Image URL
| URL
| The URL to the image associated with this listing. Note: Only the first image associated with the listing is returned.
|
| Date Purchased
| Date (YYYY-MM-DD HH:MM:SS)
| The date the listing was purchased, in EST/EDT.
|
| Currency
| ARS, AUD, BRL, CAD, CHF, CLP, CNY, COP, CZK, DKK, EUR, FJD, GBP, HKD, IDR, ILS, INR, INR, JPY, KRW, LKR, MAD, MXN, MYR, NOK, NZD, PAB, PEN, PHP, PKR, PLN, RUR, SEK, SGD, SIT, SKK, THB, TND, TRL, TWD, USD, VEB or ZAR
| The currency the item was listed in.
|
| Username
| Text
| The username of the member who purchased the item.
|
| Email
| Text
| The email address of the member who purchased the item.
|
| Name
| Text
| The name of the member who purchased the item.
|
| Address
| Text
| The address (number and street name) of the member who purchased the item.
|
| City
| Text
| The address (city) of the member who purchased the item.
|
| State
| Text
| The address (state) of the member who purchased the item.
|
| Zip
| Text
| The address (zip or postal code) of the member who purchased the item.
|
| Country
| Text
| The address (country) of the member who purchased the item.
|
| User Feedback
| Ineteger
| The feedback rating of the member who purchased the item.
|
| Payment Status
| Unpaid, Paid, Paid with PayPal, Paid by Check, Paid by Money Order, Paid by Credit Card, Paid with Google, Check Clearing..., Canceled, or Refunded
| The Payment Status of this transaction.
|
| Paid Date
| Date (YYYY-MM-DD HH:MM:SS)
| The date the item was paid for, in EST/EDT. Note: If the item was not yet paid the date will be '0000-00-00 00:00:00'. Additionally, if the item was marked paid, and then marked unpaid, the Paid Date will still be set.
|
| Shipment Status
| Not Shipped, Shipped, Processing, Canceled or Returned
| The Shipped Status of this transaction.
|
| Shipped Date
| Date (YYYY-MM-DD HH:MM:SS)
| The date the item was shipped, in EST/EDT. Note: If the item was not yet shipped the date will be '0000-00-00 00:00:00'. Additionally, if the item was marked shipped, and then marked not shipped, the Shipped Date will still be set.
|
| Transaction ID
| Integer
| Every sales transaction has a unique Transaction ID. When using the StampWants API to update listings (paid, shipped and feedback) you may want to use the Transaction ID, as it uniquely identifies this transaction, as opposed to the StampWants ID if the item listed has a multiple quantity. This is because if an item had a multiple quantity, more than one transaction may exist with the same StampWants ID.
|
| Field Name
| Value Type
| Description
|
| ID
| Integer (StampWants ID)
| The StampWants ID number of the listing.
|
| Private ID
| Text
| The Private ID you set for this listing, if set.
|
| Title
| Text
| The Title of the listing.
|
| Starting Bid
| Decimal
| The Starting Bid of the listing. Note: If the listing is a Fixed Price listing, or Store Item, the Starting Bid will be equal to the Buy It Now Price.
|
| Buy It Now Price
| Decimal
| The Buy It Now Price of the listing.
|
| Reserve Price
| Decimal
| The Reserve Price of the listing.
|
| Max Bid
| Decimal
| The current max bid of the listing, if a bid has been placed.
|
| Listing Type
| standard, store or public
| If the listing is either an auction or fixed price listing, the value of this field will be 'standard'. If the listing is a store item, the value of this field will be 'store'. If the listing is either a Public Auction or Mail Sale listing, the value of this field will be 'public'.
|
| Duration
| 1,3,5,7,10 or 30
| The duration of the listing. Note: Store Items will display '30' even though they do not end, because listing fees are charged every 30 days.
|
| Original Quantity
| Integer
| The original quantity available, as indicated for the listing.
|
| Quantity Available
| Integer
| The current quantity available for the listing.
|
| Category ID
| Integer Number (a valid Category Code, as found on the Category Code page)
| The Category Code of the main category of the listing.
|
| Additional Category ID
| Integer Number (a valid Category Code, as found on the Category Code page)
| The Category Code of the additional category of the listing.
|
| Image URL
| URL
| The URL to the image associated with this listing. Note: Only the first image associated with the listing is returned.
|
| End Date
| Date (YYYY-MM-DD HH:MM:SS)
| The date the listing ended, in EST/EDT.
|
| Start Date
| Date (YYYY-MM-DD HH:MM:SS)
| The date the listing started, in EST/EDT.
|
| Currency
| ARS, AUD, BRL, CAD, CHF, CLP, CNY, COP, CZK, DKK, EUR, FJD, GBP, HKD, IDR, ILS, INR, INR, JPY, KRW, LKR, MAD, MXN, MYR, NOK, NZD, PAB, PEN, PHP, PKR, PLN, RUR, SEK, SGD, SIT, SKK, THB, TND, TRL, TWD, USD, VEB or ZAR
| The currency the item is listed in.
|
| Reason Ended
| Text
| If the item was manually ended early, and a reason for ending the listing was supplied it will be displaed here.
|
| Relisted
| Integer (StampWants ID)
| If the item was relisted, the StampWants ID of the new (relisted) item will be displayed here.
|
| Field Name
| Value Type
| Description
|
| ID
| Integer (StampWants ID)
| The StampWants ID number of the listing.
|
| Title
| Text
| The Title of the listing.
|
| High Bid
| Decimal
| The current high bid of this listing.
|
| Number of Bids
| Integer
| The number of bids placed on this listing.
|
| My Max Bid
| Decimal
| Your max bid for this listing.
|
| Winning
| Yes or No
| If you are currently winning this listing.
|
| Quantity
| Integer
| The quantity of items you are bidding on in this listing.
|
| Listing Type
| standard, store or public
| If the listing is either an auction or fixed price listing, the value of this field will be 'standard'. If the listing is a store item, the value of this field will be 'store'. If the listing is either a Public Auction or Mail Sale listing, the value of this field will be 'public'.
|
| Image URL
| URL
| The URL to the image associated with this listing. Note: Only the first image associated with the listing is returned.
|
| Duration
| 1,3,5,7,10 or 30
| The duration of the listing. Note: Store Items will display '30' even though they do not end, because listing fees are charged every 30 days.
|
| End Date
| Date (YYYY-MM-DD HH:MM:SS)
| The date the listing ends, in EST/EDT.
|
| Starting Bid
| Decimal
| The Starting Bid of the listing. Note: If the listing is a Fixed Price listing, or Store Item, the Starting Bid will be equal to the Buy It Now Price.
|
| Currency
| ARS, AUD, BRL, CAD, CHF, CLP, CNY, COP, CZK, DKK, EUR, FJD, GBP, HKD, IDR, ILS, INR, INR, JPY, KRW, LKR, MAD, MXN, MYR, NOK, NZD, PAB, PEN, PHP, PKR, PLN, RUR, SEK, SGD, SIT, SKK, THB, TND, TRL, TWD, USD, VEB or ZAR
| The currency the item is listed in.
|
| Field Name
| Value Type
| Description
|
| ID
| Integer (StampWants ID)
| The StampWants ID number of the listing.
|
| Title
| Text
| The Title of the listing.
|
| Buy It Now Price
| Decimal
| The Buy It Now Price of the listing.
|
| Current Bid
| Decimal
| The current high bid of this listing.
|
| Starting Bid
| Decimal
| The Starting Bid of the listing. Note: If the listing is a Fixed Price listing, or Store Item, the Starting Bid will be equal to the Buy It Now Price.
|
| Number of Bids
| Integer
| The number of bids placed on this listing.
|
| My Max Bid
| Decimal
| Your max bid for this listing.
|
| Winning
| Yes or No
| If you are currently winning this listing.
|
| Quantity
| Integer
| The quantity of items available for this listing.
|
| Listing Type
| standard, store or public
| If the listing is either an auction or fixed price listing, the value of this field will be 'standard'. If the listing is a store item, the value of this field will be 'store'. If the listing is either a Public Auction or Mail Sale listing, the value of this field will be 'public'.
|
| Image URL
| URL
| The URL to the image associated with this listing. Note: Only the first image associated with the listing is returned.
|
| Duration
| 1,3,5,7,10 or 30
| The duration of the listing. Note: Store Items will display '30' even though they do not end, because listing fees are charged every 30 days.
|
| End Date
| Date (YYYY-MM-DD HH:MM:SS)
| The date the listing ends, in EST/EDT.
|
| Currency
| ARS, AUD, BRL, CAD, CHF, CLP, CNY, COP, CZK, DKK, EUR, FJD, GBP, HKD, IDR, ILS, INR, INR, JPY, KRW, LKR, MAD, MXN, MYR, NOK, NZD, PAB, PEN, PHP, PKR, PLN, RUR, SEK, SGD, SIT, SKK, THB, TND, TRL, TWD, USD, VEB or ZAR
| The currency the item is listed in.
|
| Field Name
| Value Type
| Description
|
| ID
| Integer (StampWants ID)
| The StampWants ID number of the listing.
|
| Title
| Text
| The Title of the listing.
|
| Amount
| Decimal
| The amount you purchased the item for in this specific transaction.
|
| Quantity
| Integer
| The quantity of this particular listing you purchased in this specific transaction. Note: This will be 1 unless the listing had a multiple quantity.
|
| Starting Bid
| Decimal
| The Starting Bid of the listing. Note: If the listing is a Fixed Price listing, or Store Item, the Starting Bid will be equal to the Buy It Now Price.
|
| Buy It Now Price
| Decimal
| The Buy It Now Price of the listing.
|
| Listing Type
| standard, store or public
| If the listing is either an auction or fixed price listing, the value of this field will be 'standard'. If the listing is a store item, the value of this field will be 'store'. If the listing is either a Public Auction or Mail Sale listing, the value of this field will be 'public'.
|
| Image URL
| URL
| The URL to the image associated with this listing. Note: Only the first image associated with the listing is returned.
|
| Date Purchased
| Date (YYYY-MM-DD HH:MM:SS)
| The date the listing was purchased, in EST/EDT.
|
| Currency
| ARS, AUD, BRL, CAD, CHF, CLP, CNY, COP, CZK, DKK, EUR, FJD, GBP, HKD, IDR, ILS, INR, INR, JPY, KRW, LKR, MAD, MXN, MYR, NOK, NZD, PAB, PEN, PHP, PKR, PLN, RUR, SEK, SGD, SIT, SKK, THB, TND, TRL, TWD, USD, VEB or ZAR
| The currency the item was listed in.
|
| Username
| Text
| The username of the seller who you purchased the item from.
|
| Email
| Text
| The email address of the seller who you purchased the item from.
|
| Name
| Text
| The name of the seller who you purchased the item from.
|
| Address
| Text
| The address (number and street name) of the seller who you purchased the item from.
|
| City
| Text
| The address (city) of the seller who you purchased the item from.
|
| State
| Text
| The address (state) of the seller who you purchased the item from.
|
| Zip
| Text
| The address (zip or postal code) of the seller who you purchased the item from.
|
| Country
| Text
| The address (country) of the seller who you purchased the item from.
|
| User Feedback
| Ineteger
| The feedback rating of the seller who you purchased the item from.
|
| Payment Status
| Unpaid, Paid, Paid with PayPal, Paid by Check, Paid by Money Order, Paid by Credit Card, Paid with Google, Waiting..., Canceled, or Refunded
| The Payment Status of this transaction, as you have indicated.
|
| Paid Date
| Date (YYYY-MM-DD HH:MM:SS)
| The date the item was paid for (when you indicated the item was paid), in EST/EDT. Note: If the item was not yet paid the date will be '0000-00-00 00:00:00'. Additionally, if the item was marked paid, and then marked unpaid, the Paid Date will still be set.
|
| Received Status
| Not Received, Received, Canceled or Returned
| The Received Status of this transaction.
|
| Received Date
| Date (YYYY-MM-DD HH:MM:SS)
| The date the item was received, in EST/EDT. Note: If the item was not yet received the date will be '0000-00-00 00:00:00'. Additionally, if the item was marked received, and then marked not received, the Received Date will still be set.
|
| Seller Payment Status
| Unpaid, Paid, Paid with PayPal, Paid by Check, Paid by Money Order, Paid by Credit Card, Paid with Google, Check Clearing..., Canceled, or Refunded
| The Payment Status of this transaction, as indicated by the seller.
|
| Seller Paid Date
| Date (YYYY-MM-DD HH:MM:SS)
| The date the item was paid for (when the seller indicated the item was paid), in EST/EDT. Note: If the item was not yet paid the date will be '0000-00-00 00:00:00'. Additionally, if the item was marked paid, and then marked unpaid, the Paid Date will still be set.
|
| Seller Shipment Status
| Not Shipped, Shipped, Processing, Canceled or Returned
| The Shipped Status of this transaction, as indicated by the seller.
|
| Seller Shipped Date
| Date (YYYY-MM-DD HH:MM:SS)
| The date the item was shipped, in EST/EDT. Note: If the item was not yet shipped the date will be '0000-00-00 00:00:00'. Additionally, if the item was marked shipped, and then marked not shipped, the Shipped Date will still be set.
|
| Transaction ID
| Integer
| Every sales transaction has a unique Transaction ID. When using the StampWants API to update listings (paid, shipped and feedback) you may want to use the Transaction ID, as it uniquely identifies this transaction, as opposed to the StampWants ID if the item listed has a multiple quantity. This is because if an item had a multiple quantity, more than one transaction may exist with the same StampWants ID.
|
| Field Name
| Value Type
| Description
|
| ID
| Integer (StampWants ID)
| The StampWants ID number of the listing.
|
| Title
| Text
| The Title of the listing.
|
| High Bid
| Decimal
| The current high bid of this listing.
|
| Number of Bids
| Integer
| The number of bids placed on this listing.
|
| My Max Bid
| Decimal
| Your max bid for this listing.
|
| Quantity
| Integer
| The quantity of items you are bidding on in this listing.
|
| Listing Type
| standard, store or public
| If the listing is either an auction or fixed price listing, the value of this field will be 'standard'. If the listing is a store item, the value of this field will be 'store'. If the listing is either a Public Auction or Mail Sale listing, the value of this field will be 'public'.
|
| Image URL
| URL
| The URL to the image associated with this listing. Note: Only the first image associated with the listing is returned.
|
| Duration
| 1,3,5,7,10 or 30
| The duration of the listing. Note: Store Items will display '30' even though they do not end, because listing fees are charged every 30 days.
|
| End Date
| Date (YYYY-MM-DD HH:MM:SS)
| The date the listing ends, in EST/EDT.
|
| Starting Bid
| Decimal
| The Starting Bid of the listing. Note: If the listing is a Fixed Price listing, or Store Item, the Starting Bid will be equal to the Buy It Now Price.
|
| Currency
| ARS, AUD, BRL, CAD, CHF, CLP, CNY, COP, CZK, DKK, EUR, FJD, GBP, HKD, IDR, ILS, INR, INR, JPY, KRW, LKR, MAD, MXN, MYR, NOK, NZD, PAB, PEN, PHP, PKR, PLN, RUR, SEK, SGD, SIT, SKK, THB, TND, TRL, TWD, USD, VEB or ZAR
| The currency the item is listed in.
|
| Field Name
| Value Type
| Description
|
| ID
| Integer (StampWants ID)
| The StampWants ID number of the listing.
|
| Title
| Text
| The Title of the listing.
|
| Name
| Text
| The Title of the Public Auction of Mail Sale.
|
| Lot Number
| Text
| The Lot Number (within the Public Auction of Mail Sale).
|
| High Bid
| Decimal
| The current high bid of this listing.
|
| Number of Bids
| Integer
| The number of bids placed on this listing.
|
| My Max Bid
| Decimal
| Your max bid for this listing.
|
| Quantity
| Integer
| The quantity of items you are bidding on in this listing.
|
| Listing Type
| standard, store or public
| If the listing is either an auction or fixed price listing, the value of this field will be 'standard'. If the listing is a store item, the value of this field will be 'store'. If the listing is either a Public Auction or Mail Sale listing, the value of this field will be 'public'.
|
| Image URL
| URL
| The URL to the image associated with this listing. Note: Only the first image associated with the listing is returned.
|
| Duration
| 1,3,5,7,10 or 30
| The duration of the listing. Note: Store Items will display '30' even though they do not end, because listing fees are charged every 30 days.
|
| End Date
| Date (YYYY-MM-DD HH:MM:SS)
| The date the listing ends, in EST/EDT.
|
| Starting Bid
| Decimal
| The Starting Bid of the listing. Note: If the listing is a Fixed Price listing, or Store Item, the Starting Bid will be equal to the Buy It Now Price.
|
| Currency
| ARS, AUD, BRL, CAD, CHF, CLP, CNY, COP, CZK, DKK, EUR, FJD, GBP, HKD, IDR, ILS, INR, INR, JPY, KRW, LKR, MAD, MXN, MYR, NOK, NZD, PAB, PEN, PHP, PKR, PLN, RUR, SEK, SGD, SIT, SKK, THB, TND, TRL, TWD, USD, VEB or ZAR
| The currency the item is listed in.
|
