Manages Access to the AppointmentTrader Account

get_list

Returns all available user accounts including their balances and if applicable credit limits in the smallest possible currency unit

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_category_list

Searches all categories

get_city_list

Searches all categories

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.

get_metric_history

Returns history of location metrics across a defined timeframe

get_metrics

Returns detailed 90 day location trading metrics

get_related_location_list

Returns locations that are related to locationAlias

set

Create a Location

set_general_opening_hours

Set a locations opening hours.

set_listing

Submits a new listing for review or if the user has the Permission::SelfReviewListings the listing will be approved.

set_subscribe_to_city_area_priority_bids

Subscribe to Concierge Bids for the Area

set_subscribe_to_location_priority_bids

Subscribe to Insider Bids

set_unlock_exact_listing_times

Unlock Exact Listing Times

set_unsubscribe_from_city_area_priority_bids

Unsubscribe from Concierge Bids for the Area

set_unsubscribe_from_location_priority_bids

Unsubscribe from Insider Bids

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

Legacy alias for /v1/portfolio/get_listings

set_archive

Archive Listing

set_cancel_bid

Cancels a bid

set_create_from_template

Creates an appointment from a template,

set_fill_bid

Fills a bid with a portfolio listing that is either off market or publicly available

set_market_visibility

Changes the visibility in the market.

set_price

Changes the current listing price

set_purchase

Purchase a listing

Manages all portfolio related functions

get_last_order_list_id

Returns the order list that has been used last by the api user

get_listings

Returns all listings in the users portfolio.

get_order_list_items

Returns the order list items for $orderListID

get_order_lists

Returns all available orderlists

get_valid_location_identifiers

Searches available location identifiers for purposes of creating a buy order

set_bulk_bid_order

Create a Bulk Buy Order

set_delete_order_list

Delete order list

set_delete_order_list_item

Deletes an order list item

set_order_list

Create a new order list

set_order_list_item

Saves an order list item

set_rename_order_list

Rename order list

set_suggest_list_to_user

Returns the order list that has been used last by the user

set_update_order_list_item_quantity

Updates the quantity of an item

Manages all bid related functions

get_list

Returns all available bids with a reporting delay of 5 minutes.

set

Places a bid

Contains all market data related functions to allow sellers to pick up on trends throughout the year

get_highest_converting_locations

Returns the best converting venues, indicating the most demand for listings

get_most_bids_least_asks

Returns locations with the highest bids vs listing ratio

get_most_underserved_locations

Returns locations with the most bids and the least number of listings in the past 30 days

get_most_viewed_locations_with_least_listings

Returns the most viewed locations with the least amount of listings

get_required_inventory_forecast

Returns inventory that may have high chance of selling based on historical data

get_toplist

Returns locations with the most bids and the least number of listings in the past 30 days

Manages All Medal and User Permission Related Functions

get_achievement_bonus_types

Searches all available requirements

get_available_medal_categories

Searches all available medal categories on the platform

get_available_medals

Searches all available medals on the platform

get_available_permissions

Searches all available requirements

get_available_requirements

Searches all available requirements

set_achievement_bonus

Create a bonus for the Medal

set_create_medal

Create A New Medal

set_delete_achievement_bonus

Delete the Achievement Bonus

set_edit_medal

Edit Medal

set_link_permission

Link a permission to the Medal

set_link_requirement

Link a requirement to the Medal

set_request_medal_sponsorship

Request Medal Sponsorship

set_sponsor_user

Sponsor A Medal for

set_unlink_permission

Delete the Medal Permission link

set_unlink_requirement

Delete the Medal Requirement link

Contains all user related functions

get

Searches all user aliasses

get_alternative_access_userlist

List of users who can access this account

get_alternative_session_lifetime_presets

Returns a commonly used list of preset values

get_evaluate_permission

Returns the current value of the requested permission

get_transaction_history

Returns transaction history for the user

get_user_to_user_chat_tag_id

Returns the chat id for the user-to-user chat

set_grant_access

Give another user access to this account

set_initiate_suspension

Initiates the user suspension process

set_referred_user

Link a user to be a referred

set_reinstate

Reinstate user privileges

Manages all notification related functions

set_readstate

Changes the visibility of the notifications in the ID list

Provides helpful functions to compliment appointment trades

get_convert_currency

Converts a currency amount

get_geoip_data

Returns geolocation data from an ipaddress

Manages Community Related Functions

set_create_poll_answer_for_question

Create a new answer option for the Question

set_create_poll_question_for_post

Create a new poll question for the Post

set_submit_vote_for_question

Saves a poll answer