AppointmentTrader API Documentation
Welcome to the first version of AppointmentTrader API.
Great to see you are starting to use it!
To keep things simple, the API is designed for you to be able to request any endpoint with a HTTPS GET or POST call, whether the endpoint will write or read data.
In some edge cases you might need a POST request to transmit more data - more than likely you won't need that, but should you use a POST request, know that every parameter passed in via POST is prioritized over a passed GET parameter.
All values will be returned as a json encoded object.
Every response is structured as follows:
RequestStatus: "Succeeded" or "Failed"
ResponseCode: 100-100,000 (for success codes) 399-500,000 (for failure codes)
ResponseMessage: Details on what went right or wrong.
Only If the request succceeded there will the following parameter:
Payload: Data will be structure as indicated in the 'return' section of each endpoint description.
/v1/location/
Handles all location related functions.
get_category
Returns the locations category type (f.i. Restaurant or Prepaid-Restaurant) and the required field list for listings of this category.
get_comparable_trades
Returns comparable price information for any inventory type and date.
get_inventory_types
Returns the inventory types available for the requested location.
set_listing
Submits a new listing for review.
Please keep in mind that account limits apply as posted in the permission overview of your account.
Note: This function currently only supports single timeslot listings, support for multiday listings such as hotel listings will follow.
Support for virtual phone, email and card numbers will also follow in a future release.
/v1/listing/
Manages portfolio related functions such as price changes and status changes
get_competing_listings
Lists competing listings in a certain timeframe, along with pricing information
get_portfolio_listings
Returns all listings in the users portfolio.
set_market_visibility
Changes the visibility in the market.
In the portal private listings appear in the private section and public in 'Publicly traded listings'
set_price
Changes the current listing price
/v1/tools/
Provides helpful functions to compliment appointment trades
get_convert_currency
Converts a currency amount
Attention: DO NOT USE for moneteray transactions, values are approximate!
get_geoip_data
Returns geolocation data from an ipaddress
