360Works Auctioneer plugin/Documentation

From 360Works Product Documentation Wiki
Jump to: navigation, search

Contents

360Works Auctioneer plugin User Guide

This plugin can be used to read auction data from eBay into FileMaker Pro.


360Works Plugin Setup Guides

See Plugins_101 for Error reporting, installation, registration, and more.

Function Summary

  • ebayEnableDialog ( dialogEnabled ) — This function enables dialog boxes to be exposed to the user.
  • eBayGetItemInfo ( itemNumber; attribute {; optionalParams } ) — This returns a piece of information (attribute) about the eBay item (itemNumber).
  • eBayGetItemPicture ( itemNumber; whichPicture ) — This function will download a picture (pictureNumber) from the item (itemNumber) which can then be stored in a container field.
  • eBayGetLoginURL ( username; password ) — This gets your login URL to be used for your bidding session.
  • eBayGetWatchList — This returns a list of item numbers on your eBay watch list.
  • eBayLastError — Returns a human-readable description of whatever caused the last error.
  • eBayMakePurchase ( itemNumber; amount ) — This function will place a maximum bid on an item (itemNumber) for the specified amount in the auction's currency (amount).
  • eBayPlaceBid ( itemNumber; amount {; optionalParams } ) — This function will place a maximum bid on an item (itemNumber) for the specified amount in the auction's currency (amount).
  • eBaySetErrorCapture ( errorCapture ) — Use eBaySetErrorCapture( true ) to disable automatic error reporting.
  • eBayVersion — Returns the plugin version number, ie.

Function Detail

ebayEnableDialog ( dialogEnabled )

This function enables dialog boxes to be exposed to the user. (stub)  

Parameters:

dialogEnabled

Returns:

eBayGetItemInfo ( itemNumber; attribute {; optionalParams } )

This returns a piece of information (attribute) about the eBay item (itemNumber). You must first log in at the webpage returned by eBayGetLoginURL before calling this function.

All currency amounts are returned in the primary currency on the Item's auction page. The attribute parameter must be an item from this list:
  • title - This is the heading for the item.
  • description - This is the auction detail.
  • startPrice - This is the price that the auction started at.
  • currentPrice - This is the highest current bid for the item.
  • buyItNowPrice - If there is a buy-it-now option for the item, this is the price. Otherwise this will be empty.
  • closingDate - This is a timestamp value (date and time) of when the auction ends.
  • secondsRemaining - Number of seconds remaining until the auction ends.
  • location - This is descriptive text of where the item will be shipped from.
  • status (Active / Ended / Completed)
  • pictureCount - the number of pictures for this item. This can then be passed as a parameter to ebayGetItemPicture
  • sellerId - This is the seller ID, not the full name.
  • sellerFeedbackScore - The total feedback score for the seller
  • sellerPositiveFeedbackPercent - Percentage of feedback which is positive, ie. 100.0
  • flatShippingCost - This returns the lowest shipping cost, if it is available as a flat amount
  • shippingOptions - This returns a return separated list of shipping options
  • paymentMethods - This returns a comma-separate list of payment methods, ie. 'PayPal'
  • condition - This returns the condition of the item
  • quantity - This returns the quantity of items available for the auction
  • optionalParams - These are key-value pairs necessary to calculate shipping costs (ex. "zip=54321", "country=US", "refresh=true")
Parameters:

itemNumber
The eBay item ID of the item you want to get information about (Ex: "250927588904")
attribute
A text value corresponding to one of the above items.


eBayGetItemPicture ( itemNumber; whichPicture )

This function will download a picture (pictureNumber) from the item (itemNumber) which can then be stored in a container field. You must first log in at the webpage returned by eBayGetLoginURL before calling this function.

Example: Set Field: MyContainer; ebayGetItemPicture("2")

Parameters:

itemNumber
The eBay item ID of the item you want to get information about (Ex: 110091724291)
pictureNumber
The number of the picture of the item you wish to download. (Ex: "2" to get the second

picture) You can find out how many pictures an item has by calling {@link #eBayGetItemInfo (itemNumber, "pictureCount")}
Returns: container data (a picture) on success, or 'ERROR' on failure.

eBayGetLoginURL ( username; password )

This gets your login URL to be used for your bidding session. You must sign in at the URL returned by this function before you can call any other eBay auction-related functions.

Parameters:

username
Your eBay.com account login username.
password
Your eBay.com account login password.

Returns: login URL on success, or 'ERROR' on failure.

eBayGetWatchList

This returns a list of item numbers on your eBay watch list. You must first log in at the webpage returned by eBayGetLoginURL before calling this function.


eBayLastError

Returns a human-readable description of whatever caused the last error.


eBayMakePurchase ( itemNumber; amount )

This function will place a maximum bid on an item (itemNumber) for the specified amount in the auction's currency (amount). You must first log in at the webpage returned by eBayGetLoginURL before calling this function.

Example: Set Variable: [ebayPlaceBid ( "110091724291"; 125)]

Parameters:

itemNumber
The item number of the item you wish to bid on. (Ex: 110091724291)
amount
The amount you wish to bid in the auction's currency. Do not include currency signs. (Ex: 125)

Returns: 1 on success, or 'ERROR' on failure.

eBayPlaceBid ( itemNumber; amount {; optionalParams } )

This function will place a maximum bid on an item (itemNumber) for the specified amount in the auction's currency (amount). You must first log in at the webpage returned by eBayGetLoginURL before calling this function.

Example: Set Variable: [ebayPlaceBid ( "110091724291"; 125)]

Parameters:

itemNumber
The item number of the item you wish to bid on. (Ex: 110091724291)
amount
The amount you wish to bid in the auction's currency. Do not include currency signs. (Ex: 125)

Returns: 1 on success, or 'ERROR' on failure.

eBaySetErrorCapture ( errorCapture )

Use eBaySetErrorCapture( true ) to disable automatic error reporting.

Parameters:


eBayVersion

Returns the plugin version number, ie. "1.0"

Personal tools
Namespaces

Variants
Actions
Plug-in Products
Other Products
Navigation
Toolbox