FREE USAGE
Tinypay.me

Tinypay.me

http://developers.tinypay.me

melvinmt

Simple e-commerce API for selling or buying physical and digital items. No registration of your users required - authenticate with PayPal only. Make money on every sale. Visit the blog for updates and tutorials.
running

59 devs hack on this API: 

API Docs

Test Console

Tag Shopping
Download a client library: .m Obj-C .php php .py python .rb ruby .java java

Methods

  • checkOAuthAccessToken
  • contactUser
  • createItem
  • createOrder
  • createSSOToken
  • deleteItem
  • deleteOAuthAccessToken
  • getCharities
  • getCountries
  • getCountriesByRegion
  • getCurrencies
  • getDownload
  • getGeoRadius
  • getItem
  • getLanguages
  • getMarketplace
  • getMarketplaceCategorySearch
  • getMarketplaceSearch
  • getMarketplaceUsers
  • getMyItems
  • getMyMarketplaces
  • getMyOrders
  • getMyProfile
  • getOAuthAccessToken
  • getOAuthPermission
  • getOrderStatus
  • getRegions
  • getSearch
  • getSearchSuggestions
  • getShipmentCountries
  • getUserItems
  • getUserProfile
  • getWidget
  • updateItem
  • updateMyProfile
  • uploadFile
  • uploadImage

checkOAuthAccessToken (GET)

This method has no description

Parameters

access_token
NONE

This parameter field has no description

Results

success
NONE

This result field has no description

Example

JSON 
{"success":"sample value"}

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/oauth/access_token/{access_token}
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

contactUser (POST) 

Contact an user to ask a question about an item.

Parameters

access_token
STRING
This method requires a valid access_token. You can obtain your personal access token by logging in here: https://tinypay.me/oauth/your_token or request permission from another user with "getOAuthPermission".

For example: "ilkOk4bHj8huCtJnAUx0wY5KHQNnK99uJ8ygN3P1fk... (84 chars)"

user_id
STRING
The ID of the user you want to send a message to

For example: "sPSjqB4Q"

name
STRING
The name of the sender

For example: "Uncle Joe "

email
STRING
The e-mail address of the sender

For example: "info@example.com"

message
STRING
The message contents of the contact mail

For example: "Hi, do you also have the jeans in black?"

subject(optional)
STRING
The subject of the message

For example: "Question about your jeans"

Results

success
BOOLEAN
Returns true or false

For example: "true"

Example

JSON 
{"success":true}

JSON (Learn how)

POST https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/user/{user_id}/contact

access_token=A-VALUE
name=A-VALUE
email=A-VALUE
message=A-VALUE
subject=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

createItem (POST) 

Create a new item.

Parameters

access_token
STRING
This method requires a valid access_token. You can obtain your personal access token by logging in here: https://tinypay.me/oauth/your_token or request permission from another user with "getOAuthPermission" (requires 'create_item' permission).

For example: "ilkOk4bHj8huCtJnAUx0wY5KHQNnK99uJ8ygN3P1fk... (84 chars)"

title
STRING
The title of your item

For example: "Monkey T-shirt (White)"

currency
STRING
The currency of your item. You can find all supported currencies with the "getCurrencies" method.

For example: "USD"

price
NUMBER
The price of your item.

For example: "14.99"

description
STRING
The description of your item. The better your description, the better your chances of selling!

For example: "Original Monkey shirts! Handmade in Oakland, California."

tags(optional)
STRING
The tags of your item. Use tags to improve the searchability and distribution of your item. You can insert multiple tags by separating them with commas. Maximum 20 tags allowed.

For example: "t-shirt,monkey,white"

quantity(optional)
NUMBER
The quantity of your item. Use -1 for unlimited and 1 or more for fixed amounts.

For example: "20"

require_shipment_address(optional)
BOOLEAN
Requires your buyers to enter a shipment address when they're buying your item. Comes in handy if you want to know where to ship your item! Default: false.

For example: "true"

shipment_countries(optional)
STRING
Define the countries or regions that you'll be able to ship your item to. Use the 2 letter country code for individual countries or the regions from the "getRegions" method to define all the countries in a region at once! You can define multiple shipment_countries by separating them with a comma.

For example: "US,FR,IT,european_union"

shipment_costs(optional)
STRING
Define the shipment costs for the countries or regions you've defined in 'shipment_countries'. Make sure you put the costs in the same order! Separate multiple costs with a comma.

For example: "2,4.50,5,6.90"

shipment_costs_per_item(optional)
BOOLEAN
Charges shipment costs per item instead per order. This means that the shipment costs will increase with every item. Default: false.

For example: "false"

geo_latitude(optional)
NUMBER
The latitude coordinate for your item. If your item doesn't have a physical location simply provide the location of any place you'd like. Range: -90 to 90.

For example: "37.80436"

geo_longitude(optional)
NUMBER
The longitude coordinate for your item. If your item doesn't have a physical location simply provide the location of any place you'd like. Range: -180 to 180.

For example: "-122.27111"

image_tokens(optional)
STRING
The image_tokens from the images you've uploaded with "uploadImage". You can define multiple image_tokens by separating them with a comma. Keep in mind that you can always add images later on.

For example: "pIgxQUZlQHyuWrgrvRZeOdi1D6lIWyx4,nXdZjB6lFklmGWLzby7B7ynAX5fqPIWs"

file_token(optional)
STRING
The file_token from the file you've uploaded with "uploadFile". It's only possible to define a single file. Keep in mind that you can always add a file later on.

For example: "6Fe4BByWLCxGrsOtTVBIPE5RgC57EjGU"

widget_url(optional)
STRING
The widget url of an Embed.ly supported service. See http://embed.ly/providers for the entire list.

For example: "http://soundcloud.com/titanoz/lily-bizarre-fallen-titanoz-remix"

charity_id(optional)
STRING
Enter a charity_id if you want to donate a certain percentage (see charity_percentage) to a charity. You can find all supported charities with the "getCharities" method.

For example: "a7Fdfx"

charity_percentage(optional)
STRING
The percentage of your sales price you want to donate to a charity. Range: 0.01 (1%) to 1 (100%).

For example: "0.2"

language(optional)
STRING
The language in which this item is placed. This property is used to improve the searchability of your item. You can find all supported languages with the "getLanguages" method.

For example: "en-us"

country(optional)
STRING
The primary country in which this item is placed. This property is used to improve the searchability of your item. You can find all supported countries with the "getCountries" method.

For example: "US"

marketplace_category_id(optional)
STRING
Only applicable if item is placed on a marketplace with categories: the ID of the marketplace category the item should be placed in

For example: "cakFlDoI"

Results

item_id
STRING
Returns the ID of the generated item

For example: "k3UKyTp"

Example

JSON 
{"item_id":"k3UKyTp"}

JSON (Learn how)

POST https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/item

access_token=A-VALUE
title=A-VALUE
currency=A-VALUE
price=A-VALUE
description=A-VALUE
tags=A-VALUE
quantity=A-VALUE
require_shipment_address=A-VALUE
shipment_countries=A-VALUE
shipment_costs=A-VALUE
shipment_costs_per_item=A-VALUE
geo_latitude=A-VALUE
geo_longitude=A-VALUE
image_tokens=A-VALUE
file_token=A-VALUE
widget_url=A-VALUE
charity_id=A-VALUE
charity_percentage=A-VALUE
language=A-VALUE
country=A-VALUE
marketplace_category_id=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

createOrder (POST) 

Place a new order for an item.

Parameters

item_id
STRING
The ID of the item you want to order

For example: "PBsgWR7"

name
STRING
The name of the buyer

For example: "Steve Jobs"

email
STRING
The e-mail address of the buyer

For example: "sjobs@apple.com"

address_line_1(optional)
STRING
The first address line of the shipment address

For example: "1 Infinite Loop"

address_line_2(optional)
STRING
The second address line of the shipment address

For example: "CEO's office"

postal_zip_code(optional)
STRING
The postal or zip code of the shipment address

For example: "95014"

state_province(optional)
STRING
The state or province of the shipment address

For example: "CA"

city(optional)
STRING
The city of the shipment address

For example: "Cupertino"

country(optional)
STRING
The 2 letter ISO 3166-1 country code

For example: "US"

comment(optional)
STRING
The comment you'd like to leave for the seller.

For example: "Hi, please make sure you ring twice."

quantity(optional)
STRING
The amount of items you want to order

For example: "2"

cancel_url(optional)
STRING
The url the buyer should be redirected to if the payment fails

For example: "http://example.com/order/fail"

return_url(optional)
STRING
The url the buyer should be redirected to if the payment succeeds

For example: "http://example.com/order/success"

marketplace_id(optional)
STRING
The ID of one of your Marketplaces. This will be used to deduct your sales fee from the seller so make sure you don't forget this! If you don't provide an ID the seller will be charged 0%.

For example: "mYcyh0q4"

access_token(optional)
STRING
Access token of the seller (only needed if you decide to use custom_price)

For example: "OvxHFe9K7xKLO3N3VJ57QnszWDUYfxy..."

custom_price(optional)
NUMBER
Sell your item at a custom price (only the seller him/herself is allowed to customize the price).

For example: "24.99"

Results

order_id
STRING
The ID of the created order

For example: "ofrqtJiHB7JUUL25q7zXWZsfhU7OYh0o"

paypal_url
STRING
The unique URL for the PayPal payment. Redirect your user to this URL to complete the payment. Note: you can only use this URL once!

For example: "https://www.paypal.com/..."

Example

JSON 
{"order_id":"ofrqtJiHB7JUUL25q7zXWZsfhU7OYh0o","paypal_url":"https://www.paypal.com/..."}

JSON (Learn how)

POST https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/item/{item_id}/order

name=A-VALUE
email=A-VALUE
address_line_1=A-VALUE
address_line_2=A-VALUE
postal_zip_code=A-VALUE
state_province=A-VALUE
city=A-VALUE
country=A-VALUE
comment=A-VALUE
quantity=A-VALUE
cancel_url=A-VALUE
return_url=A-VALUE
marketplace_id=A-VALUE
access_token=A-VALUE
custom_price=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

createSSOToken (GET)

This method has no description

Parameters

access_token
NONE

This parameter field has no description

Results

sso_token
NONE

This result field has no description

Example

JSON 
{"sso_token":"sample value"}

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/sso?access_token=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

deleteItem (POST) 

Delete an item.

Parameters

access_token
STRING
This method requires a valid access_token. You can obtain your personal access token with "getMyAccessToken"  or request permission from another user with "getOAuthPermission" (requires 'delete_item' permission). The access token user has to be the owner of this item to be able to perform this action.

For example: "ilkOk4bHj8huCtJnAUx0wY5KHQNnK99uJ8ygN3P1fk... (84 chars)"

item_id
STRING
The ID of the item you want to delete.

For example: "NbJq6B4"

Results

success
BOOLEAN
Returns true or false.

For example: "true"

Example

JSON 
{"success":true}

JSON (Learn how)

POST https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/item/{item_id}/delete

access_token=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

deleteOAuthAccessToken (POST) 

Disconnect an user from your marketplace.

Parameters

access_token
STRING
This method requires an existing access_token from another user that you got with "getOAuthPermission".

For example: "ilkOk4bHj8huCtJnAUx0wY5KHQNnK99uJ8ygN3P1fk... (84 chars)"

marketplace_id
STRING
The ID of the marketplace that is connected to this access token.

For example: "mYcyh0q4"

Results

success
BOOLEAN
True on success (this method is idempotent so it will always return true if the access token has already been deleted.)

For example: "true"

Example

JSON 
{"success":true}

JSON (Learn how)

POST https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/oauth/access_token/{access_token}/delete

marketplace_id=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getCharities (GET) 

View all supported charities.

Parameters

This method has no parameters

Results (Array)

charity_id (optional)
STRING
The ID of the charity

For example: "W0NFmK"

description (optional)
STRING
The description of the charity

For example: "Founded by Linkin Park in 2005, Music For Relief is a non-profit dedicated to natural disaster relief and mitigation around the world."

link (optional)
STRING
The website of the charity

For example: "http://www.musicforrelief.org"

percentage (optional)
STRING
Item only: shows the charity percentage that gets donated to the charity.

For example: "0.2"

title (optional)
STRING
The title of the charity

For example: "Music For Relief"

twitter (optional)
STRING
The Twitter username of the charity. Use this to send tweets!

For example: "@MusicForRelief"

Example

JSON 
[{"charity_id":"W0NFmK","description":"Founded by Linkin Park in 2005, Music For Relief is a non-profit dedicated to natural disaster relief and mitigation around the world.","link":"http://www.musicforrelief.org","percentage":"0.2","title":"Music For Relief","twitter":"@MusicForRelief"}]

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/charities
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getCountries (GET) 

View all supported countries.

Parameters

language(optional)
NONE

This parameter field has no description

Results (Array)

code
STRING
The 2 letter ISO 3166-1 country code

For example: "US"

title
STRING
The title of the country

For example: "United States"

Example

JSON 
[{"code":"US","title":"United States"}]

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/countries?language=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getCountriesByRegion (GET) 

View all supported countries within a region.

Parameters

region
STRING
The region code. See "getRegions" for all supported regions.

For example: "european_union"

Results (Array)

code
STRING
The 2 letter ISO 3166-1 country code

For example: "NL"

title
STRING
The title of the country

For example: "The Netherlands"

Example

JSON 
[{"code":"NL","title":"The Netherlands"}]

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/countries/{region}
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getCurrencies (GET) 

View all supported currencies.

Parameters

This method has no parameters

Results (Array)

code
STRING
The ISO 4217 currency code.

For example: "EUR"

exchange_rate
STRING
The exchange rate of the currency in relation to the US Dollar. Updates every 3 hours.

For example: "1.39721981202"

sign
STRING
The currency sign.

For example: "€"

title
STRING
The English title of the currency.

For example: "Euros"

Example

JSON 
[{"code":"EUR","exchange_rate":"1.39721981202","sign":"€","title":"Euros"}]

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/currencies
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getDownload (GET) 

Retrieve the download link to a purchased file

Parameters

access_token
STRING
This method requires a valid access_token. You can obtain your personal access token by logging in here: https://tinypay.me/oauth/your_token or request permission from another user with "getOAuthPermission".

For example: "ilkOk4bHj8huCtJnAUx0wY5KHQNnK99uJ8ygN3P1fk... (84 chars)"

order_id
STRING
The ID of the order.

For example: "oVlxpIK3jWTOlMl3BOJ4qDCpjBcWSqA5"

Results

download_link
STRING
A unique download link that points directly to the digital file. Note: this link expires in 60 seconds!

For example: "http://file.tinypay.me/28ad000a0213325843f6e99..."

Example

JSON 
{"download_link":"http://file.tinypay.me/28ad000a0213325843f6e99..."}

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/order/{order_id}/download?access_token=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getGeoRadius (GET) 

Retrieves all items in a given radius on a specific geographical location.

Parameters

mylat(optional)
NUMBER
Your longitude coordinates. (-180 to 180).

For example: "37.789644"

mylon(optional)
NUMBER
Your latitude coordinates (-90 to 90).

For example: "-122.395456"

range(optional)
NUMBER
The radius in units defined by "unit".

For example: "1500"

unit(optional)
STRING
The units in which radius is defined. "mi" (miles), "km" (kilometer),  "m" (meter), "yd" (yard) and "ft" (feet) are allowed.

For example: "mi"

Results

results
array of OBJECT
See the "getSearch" method for the returned parameters.
item_id (optional)
NONE

This result field has no description

item_url (optional)
NONE

This result field has no description

title (optional)
NONE

This result field has no description

description (optional)
NONE

This result field has no description

price (optional)
NONE

This result field has no description

currency (optional)
NONE

This result field has no description

user_id (optional)
NONE

This result field has no description

user_name (optional)
NONE

This result field has no description

user_url (optional)
NONE

This result field has no description

user (optional)
OBJECT

This result field has no description

user_id (optional)
NONE

This result field has no description

url (optional)
NONE

This result field has no description

name (optional)
NONE

This result field has no description

avatar (optional)
NONE

This result field has no description

bio (optional)
NONE

This result field has no description

time_created (optional)
NONE

This result field has no description

language (optional)
NONE

This result field has no description

rating (optional)
NONE

This result field has no description

facebook (optional)
NONE

This result field has no description

linkedin (optional)
NONE

This result field has no description

twitter (optional)
NONE

This result field has no description

marketplace_id (optional)
NONE

This result field has no description

category_id (optional)
NONE

This result field has no description

thumbnail (optional)
NONE

This result field has no description

image (optional)
OBJECT

This result field has no description

original (optional)
NONE

This result field has no description

large (optional)
NONE

This result field has no description

medium (optional)
NONE

This result field has no description

small (optional)
NONE

This result field has no description

xsmall (optional)
NONE

This result field has no description

xxsmall (optional)
NONE

This result field has no description

geo (optional)
OBJECT

This result field has no description

latitude (optional)
NONE

This result field has no description

longitude (optional)
NONE

This result field has no description

results_count
NONE

This result field has no description

results_from
NONE

This result field has no description

results_to
NONE

This result field has no description

total_count
NONE

This result field has no description

Example

JSON 
{"results":[{"item_id":"sample value","item_url":"sample value","title":"sample value","description":"sample value","price":"sample value","currency":"sample value","user_id":"sample value","user_name":"sample value","user_url":"sample value","user":{"user_id":"sample value","url":"sample value","name":"sample value","avatar":"sample value","bio":"sample value","time_created":"sample value","language":"sample value","rating":"sample value","facebook":"sample value","linkedin":"sample value","twitter":"sample value"},"marketplace_id":"sample value","category_id":"sample value","thumbnail":"sample value","image":{"original":"sample value","large":"sample value","medium":"sample value","small":"sample value","xsmall":"sample value","xxsmall":"sample value"},"geo":{"latitude":"sample value","longitude":"sample value"}}],"results_count":"sample value","results_from":"sample value","results_to":"sample value","total_count":"sample value"}

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/georadius?mylat=A-VALUE&mylon=A-VALUE&range=A-VALUE&unit=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getItem (GET) 

Retrieve an item.

Parameters

item_id
STRING
The ID of an item

For example: "p18t0qt"

select(optional)
STRING
Use this property to save data by selecting the properties you'd ONLY like to return. This comes in handy when you're developing mobile applications. Separate multiple properties with commas. Use the dot notation to select inner elements.

For example: "item_id,title,user_id,images.small,price,currency"

not_select(optional)
STRING
Use this property to save data by NOT selecting some of the properties. This comes in handy when you're developing mobile applications. Separate multiple properties with commas. Use the dot notation to select inner elements.

For example: "geo,images.medium,charity"

Results

charity (optional)
OBJECT
Charity details (if present).
charity_id (optional)
STRING
The ID of the charity

For example: "W0NFmK"

percentage (optional)
NUMBER
The percentage of the sales that gets donated to the charity. 0.1 (1%) to 1 (100%).

For example: "0.2"

title (optional)
STRING
The title of the charity

For example: "Music For Relief"

description (optional)
STRING
The description of the charity

For example: "Founded by Linkin Park in 2005, Music For Relief is a non-profit dedicated to natural disaster relief and mitigation around the world."

link (optional)
STRING
The website of the charity

For example: "http://www.musicforrelief.org"

twitter (optional)
STRING
The Twitter username of the charity. Use this to send tweets!

For example: "@MusicForRelief"

country (optional)
STRING
The country where this item is placed

For example: "US"

currency (optional)
STRING
The currency of this item

For example: "EUR"

description (optional)
STRING
The description of this item.

For example: "A portable and lightweight iPad Stand."

file (optional)
OBJECT
Downloadable file details (if present).
token (optional)
STRING
The file token is the identifier of the uploaded file and the result of the "uploadFile" method.

For example: "OUSffKKAEKt1TVM3Uetpu7SdMuOWoKxt"

name (optional)
STRING
The name of the downloadable file

For example: "The_Wooden_Ipad_Stand_Story.pdf.zip"

size (optional)
STRING
The file size of the downloadable file

For example: "1.46 MB"

thumbnail (optional)
STRING
Image only: thumbnail of the uploaded image.

For example: "http://img.tinypay.me/DDo7VJBn4CcuwiScDb0..."

geo (optional)
OBJECT
Geographical coordinates of this item
latitude (optional)
NUMBER
The latitude coordinate of this item

For example: "52.233"

longitude (optional)
NUMBER
The longitude coordinate of this item

For example: "5.183"

images (optional)
array of OBJECT
List of item images (if present).
original (optional)
STRING
Original size of the image.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

large (optional)
STRING
Large size of the image. Maximum dimensions: 800 x 600 px.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

medium (optional)
STRING
Medium size of the image. Maximum dimensions: 640 x 480 px.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

small (optional)
STRING
Small size of the image. Maximum dimensions: 320 x 420 px.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

xsmall (optional)
STRING
Extra small size of the image. Maximum dimensions: 180 x 135 px.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

xxsmall (optional)
STRING
Extremely small size of the image. Maximum dimensions: 90 x 68 px.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

item_id (optional)
STRING
The ID of the item

For example: "p18t0qt"

language (optional)
STRING
The language of this item

For example: "en-us"

marketplace_id (optional)
NONE

This result field has no description

price (optional)
STRING
The price of an item

For example: "14.99"

quantity (optional)
NUMBER
The quantity of an item. -1 stands for: unlimited. 0 stands for: sold out.

For example: "20"

shipment_costs (optional)
array of OBJECT
List of shipment areas and corresponding shipment costs. Use the "getShipmentCountries" method to fully expand the list of all shipment countries within regions.
area (optional)
STRING
The shipment area code.

For example: "european_union"

shipment_cost (optional)
NUMBER
The shipment costs to that area.

For example: "4.90"

is_region (optional)
BOOLEAN
Tells you whether this area is a region (which consists of multiple countries) or an individual country (2 letter ISO 3166-1 code).

For example: "true"

title (optional)
NONE

This result field has no description

shipment_costs_per_item (optional)
BOOLEAN
Tells you if this seller wants to charge shipment costs per item, instead of per order

For example: "false"

tags (optional)
array of STRING
List of tags of the item. Tags play an important role in the "getSearch" method.

For example: "game"

thumbnail (optional)
STRING
The thumbnail version of the image. Includes the price of the item.

For example: "http://img.tinypay.me/btn/p18t0qt"

time_created (optional)
NUMBER
The UNIX timestamp of when this item was created

For example: "1296330318"

title (optional)
STRING
The title of the item

For example: "The Ultra Portable Wooden iPad Stand"

url (optional)
STRING
The URL of the item

For example: "http://tinypay.me/~gwb3M6U"

user (optional)
OBJECT
The seller of this item
user_id (optional)
STRING
The ID of the user

For example: "soV3nwLn"

url (optional)
STRING
The URL of the user's profile page

For example: "http://tinypay.me/uncle-joe"

name (optional)
STRING
The name of the user

For example: "Uncle Joe"

avatar (optional)
STRING
The URL of the user's avatar

For example: "http://img.tinypay.me/user/s7pW3..."

bio (optional)
STRING
The 'about me' description of the user

For example: "Hi, welcome to my shop! Contact me if you have any questions."

time_created (optional)
NUMBER
The UNIX timestamp of when this user was created

For example: "1290853844"

language (optional)
STRING
The preferred language of the user

For example: "en-us"

rating (optional)
NUMBER
The rating of the user on a scale of 1 to 5. 0 stands for: no rating yet.

For example: "3.8"

facebook (optional)
NONE

This result field has no description

linkedin (optional)
NONE

This result field has no description

twitter (optional)
NONE

This result field has no description

widget_url (optional)
STRING
The widget url of a Embed.ly supported service. See http://embed.ly/providers for the entire list.

For example: "http://soundcloud.com/titanoz/lily-bizarre-fallen-titanoz-remix"

Example

JSON 
{"charity":{"charity_id":"W0NFmK","percentage":0.2,"title":"Music For Relief","description":"Founded by Linkin Park in 2005, Music For Relief is a non-profit dedicated to natural disaster relief and mitigation around the world.","link":"http://www.musicforrelief.org","twitter":"@MusicForRelief"},"country":"US","currency":"EUR","description":"A portable and lightweight iPad Stand.","file":{"token":"OUSffKKAEKt1TVM3Uetpu7SdMuOWoKxt","name":"The_Wooden_Ipad_Stand_Story.pdf.zip","size":"1.46 MB","thumbnail":"http://img.tinypay.me/DDo7VJBn4CcuwiScDb0..."},"geo":{"latitude":52.233,"longitude":5.183},"images":[{"original":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx...","large":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx...","medium":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx...","small":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx...","xsmall":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx...","xxsmall":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."}],"item_id":"p18t0qt","language":"en-us","marketplace_id":"sample value","price":"14.99","quantity":20,"shipment_costs":[{"area":"european_union","shipment_cost":4.90,"is_region":true,"title":"sample value"}],"shipment_costs_per_item":false,"tags":["game"],"thumbnail":"http://img.tinypay.me/btn/p18t0qt","time_created":1296330318,"title":"The Ultra Portable Wooden iPad Stand","url":"http://tinypay.me/~gwb3M6U","user":{"user_id":"soV3nwLn","url":"http://tinypay.me/uncle-joe","name":"Uncle Joe","avatar":"http://img.tinypay.me/user/s7pW3...","bio":"Hi, welcome to my shop! Contact me if you have any questions.","time_created":1290853844,"language":"en-us","rating":3.8,"facebook":"sample value","linkedin":"sample value","twitter":"sample value"},"widget_url":"http://soundcloud.com/titanoz/lily-bizarre-fallen-titanoz-remix"}

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/item/{item_id}?select=A-VALUE&not_select=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getLanguages (GET) 

View all supported languages.

Parameters

This method has no parameters

Results (Array)

code
STRING
The lowercase IETF tag of the language

For example: "en-us"

title
STRING
The English title of the language

For example: "English (US)"

Example

JSON 
[{"code":"en-us","title":"English (US)"}]

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/languages
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getMarketplace (GET) 

Retrieve a marketplace.

Parameters

marketplace_id
STRING
The ID of the marketplace. You can use internal IDs (e.g. "mteY4kEZ") or public IDs (e.g. "xboxworld").

For example: "mteY4kEZ"

select(optional)
STRING
Use this property to save data by selecting the properties you'd ONLY like to return. This comes in handy when you're developing mobile applications. Separate multiple properties with commas. Use the dot notation to select inner elements.

For example: "title,url,categories.title,logo"

not_select(optional)
STRING
Use this property to save data by NOT selecting some of the properties. This comes in handy when you're developing mobile applications. Separate multiple properties with commas. Use the dot notation to select inner elements.

For example: "description,categories.category_id,url"

Results

categories (optional)
array of OBJECT
List of marketplace categories (if present).
category_id
STRING
The ID of the marketplace category.

For example: "cENVHVhE"

title
STRING
The title of the marketplace category.

For example: "Xbox 360 Games"

url
STRING
The URL of the marketplace category

For example: "http://xboxworld.tinypay.me/#xbox-360"

description (optional)
STRING
The description of the marketplace.

For example: "Sell your Xbox 360, Wii, Playstation 3, PC games and your soul!"

logo (optional)
STRING
The URL of the logo of the marketplace.

For example: "http://img.tinypay.me/marketplace/mh9u..."

marketplace_id (optional)
STRING
The ID of the marketplace

For example: "mteY4kEZ"

title (optional)
STRING
The title of the marketplace

For example: "Xboxworld"

url (optional)
STRING
The URL of the marketplace

For example: "http://xboxworld.tinypay.me"

Example

JSON 
{"categories":[{"category_id":"cENVHVhE","title":"Xbox 360 Games","url":"http://xboxworld.tinypay.me/#xbox-360"}],"description":"Sell your Xbox 360, Wii, Playstation 3, PC games and your soul!","logo":"http://img.tinypay.me/marketplace/mh9u...","marketplace_id":"mteY4kEZ","title":"Xboxworld","url":"http://xboxworld.tinypay.me"}

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/marketplace/{marketplace_id}?select=A-VALUE&not_select=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getMarketplaceCategorySearch (GET) 

Search for all items in a specific marketplace category. 

See the "getSearch" method for more indepth documentation.

Parameters

marketplace_id
STRING
The ID of the marketplace
category_id
STRING
The ID of the marketplace category
q(optional)
STRING

This parameter field has no description

items(optional)
NUMBER

This parameter field has no description

start(optional)
NUMBER

This parameter field has no description

file(optional)
BOOLEAN

This parameter field has no description

charity(optional)
BOOLEAN

This parameter field has no description

image(optional)
BOOLEAN

This parameter field has no description

video(optional)
BOOLEAN

This parameter field has no description

shipment(optional)
BOOLEAN

This parameter field has no description

min_price(optional)
NUMBER

This parameter field has no description

max_price(optional)
NUMBER

This parameter field has no description

country(optional)
STRING

This parameter field has no description

currency(optional)
STRING

This parameter field has no description

lang(optional)
STRING

This parameter field has no description

tag(optional)
STRING

This parameter field has no description

tags(optional)
STRING

This parameter field has no description

sort_by(optional)
STRING

This parameter field has no description

select(optional)
STRING

This parameter field has no description

not_select(optional)
STRING

This parameter field has no description

Results

results
array of OBJECT

This result field has no description

item_id (optional)
NONE

This result field has no description

item_url (optional)
NONE

This result field has no description

title (optional)
NONE

This result field has no description

description (optional)
NONE

This result field has no description

price (optional)
NONE

This result field has no description

currency (optional)
NONE

This result field has no description

user_id (optional)
NONE

This result field has no description

user_name (optional)
NONE

This result field has no description

user_url (optional)
NONE

This result field has no description

user (optional)
OBJECT

This result field has no description

user_id (optional)
NONE

This result field has no description

url (optional)
NONE

This result field has no description

name (optional)
NONE

This result field has no description

avatar (optional)
NONE

This result field has no description

bio (optional)
NONE

This result field has no description

time_created (optional)
NONE

This result field has no description

language (optional)
NONE

This result field has no description

rating (optional)
NONE

This result field has no description

facebook (optional)
NONE

This result field has no description

linkedin (optional)
NONE

This result field has no description

twitter (optional)
NONE

This result field has no description

marketplace_id (optional)
NONE

This result field has no description

category_id (optional)
NONE

This result field has no description

thumbnail (optional)
NONE

This result field has no description

image (optional)
OBJECT

This result field has no description

original (optional)
NONE

This result field has no description

large (optional)
NONE

This result field has no description

medium (optional)
NONE

This result field has no description

small (optional)
NONE

This result field has no description

xsmall (optional)
NONE

This result field has no description

xxsmall (optional)
NONE

This result field has no description

geo (optional)
OBJECT

This result field has no description

latitude (optional)
NONE

This result field has no description

longitude (optional)
NONE

This result field has no description

results_count
NONE

This result field has no description

results_from
NONE

This result field has no description

results_to
NONE

This result field has no description

total_count
NONE

This result field has no description

Example

JSON 
{"results":[{"item_id":"sample value","item_url":"sample value","title":"sample value","description":"sample value","price":"sample value","currency":"sample value","user_id":"sample value","user_name":"sample value","user_url":"sample value","user":{"user_id":"sample value","url":"sample value","name":"sample value","avatar":"sample value","bio":"sample value","time_created":"sample value","language":"sample value","rating":"sample value","facebook":"sample value","linkedin":"sample value","twitter":"sample value"},"marketplace_id":"sample value","category_id":"sample value","thumbnail":"sample value","image":{"original":"sample value","large":"sample value","medium":"sample value","small":"sample value","xsmall":"sample value","xxsmall":"sample value"},"geo":{"latitude":"sample value","longitude":"sample value"}}],"results_count":"sample value","results_from":"sample value","results_to":"sample value","total_count":"sample value"}

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/marketplace/{marketplace_id}/category/{category_id}/search?q=A-VALUE&items=A-VALUE&start=A-VALUE&file=A-VALUE&charity=A-VALUE&image=A-VALUE&video=A-VALUE&shipment=A-VALUE&min_price=A-VALUE&max_price=A-VALUE&country=A-VALUE&currency=A-VALUE&lang=A-VALUE&tag=A-VALUE&tags=A-VALUE&sort_by=A-VALUE&select=A-VALUE&not_select=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getMarketplaceSearch (GET) 

Search for all items in a specific marketplace. 

See the "getSearch" method for more indepth documentation.

Parameters

marketplace_id
STRING
The ID of the marketplace.
q(optional)
STRING

This parameter field has no description

items(optional)
NUMBER

This parameter field has no description

start(optional)
NUMBER

This parameter field has no description

file(optional)
BOOLEAN

This parameter field has no description

charity(optional)
BOOLEAN

This parameter field has no description

image(optional)
BOOLEAN

This parameter field has no description

video(optional)
BOOLEAN

This parameter field has no description

shipment(optional)
BOOLEAN

This parameter field has no description

min_price(optional)
NUMBER

This parameter field has no description

max_price(optional)
NUMBER

This parameter field has no description

country(optional)
STRING

This parameter field has no description

currency(optional)
STRING

This parameter field has no description

lang(optional)
STRING

This parameter field has no description

tag(optional)
STRING

This parameter field has no description

tags(optional)
STRING

This parameter field has no description

sort_by(optional)
STRING

This parameter field has no description

select(optional)
STRING

This parameter field has no description

not_select(optional)
STRING

This parameter field has no description

Results

results
array of OBJECT

This result field has no description

item_id (optional)
STRING

This result field has no description

item_url (optional)
STRING

This result field has no description

title (optional)
STRING

This result field has no description

description (optional)
STRING

This result field has no description

price (optional)
NUMBER

This result field has no description

currency (optional)
STRING

This result field has no description

user_id (optional)
STRING

This result field has no description

user_name (optional)
STRING

This result field has no description

user_url (optional)
STRING

This result field has no description

user (optional)
OBJECT

This result field has no description

user_id (optional)
NONE

This result field has no description

url (optional)
NONE

This result field has no description

name (optional)
NONE

This result field has no description

avatar (optional)
NONE

This result field has no description

bio (optional)
NONE

This result field has no description

time_created (optional)
NONE

This result field has no description

language (optional)
NONE

This result field has no description

rating (optional)
NONE

This result field has no description

facebook (optional)
NONE

This result field has no description

linkedin (optional)
NONE

This result field has no description

twitter (optional)
NONE

This result field has no description

marketplace_id (optional)
STRING

This result field has no description

category_id (optional)
STRING

This result field has no description

thumbnail (optional)
STRING

This result field has no description

image (optional)
OBJECT

This result field has no description

original (optional)
STRING

This result field has no description

large (optional)
STRING

This result field has no description

medium (optional)
STRING

This result field has no description

small (optional)
STRING

This result field has no description

xsmall (optional)
STRING

This result field has no description

xxsmall (optional)
STRING

This result field has no description

geo (optional)
OBJECT

This result field has no description

latitude (optional)
NUMBER

This result field has no description

longitude (optional)
NUMBER

This result field has no description

results_count
NUMBER

This result field has no description

results_from
NUMBER

This result field has no description

results_to
NUMBER

This result field has no description

total_count
NUMBER

This result field has no description

Example

JSON 
{"results":[{"item_id":"sample value","item_url":"sample value","title":"sample value","description":"sample value","price":123,"currency":"sample value","user_id":"sample value","user_name":"sample value","user_url":"sample value","user":{"user_id":"sample value","url":"sample value","name":"sample value","avatar":"sample value","bio":"sample value","time_created":"sample value","language":"sample value","rating":"sample value","facebook":"sample value","linkedin":"sample value","twitter":"sample value"},"marketplace_id":"sample value","category_id":"sample value","thumbnail":"sample value","image":{"original":"sample value","large":"sample value","medium":"sample value","small":"sample value","xsmall":"sample value","xxsmall":"sample value"},"geo":{"latitude":123,"longitude":123}}],"results_count":123,"results_from":123,"results_to":123,"total_count":123}

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/marketplace/{marketplace_id}/search?q=A-VALUE&items=A-VALUE&start=A-VALUE&file=A-VALUE&charity=A-VALUE&image=A-VALUE&video=A-VALUE&shipment=A-VALUE&min_price=A-VALUE&max_price=A-VALUE&country=A-VALUE&currency=A-VALUE&lang=A-VALUE&tag=A-VALUE&tags=A-VALUE&sort_by=A-VALUE&select=A-VALUE&not_select=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getMarketplaceUsers (GET)

This method has no description

Parameters

marketplace_id
NONE

This parameter field has no description

page(optional)
NONE

This parameter field has no description

select(optional)
NONE

This parameter field has no description

not_select(optional)
NONE

This parameter field has no description

Results (Array)

avatar (optional)
NONE

This result field has no description

bio (optional)
NONE

This result field has no description

facebook (optional)
NONE

This result field has no description

language (optional)
NONE

This result field has no description

linkedin (optional)
NONE

This result field has no description

name (optional)
NONE

This result field has no description

rating (optional)
NONE

This result field has no description

time_created (optional)
NONE

This result field has no description

twitter (optional)
NONE

This result field has no description

url (optional)
NONE

This result field has no description

user_id (optional)
NONE

This result field has no description

Example

JSON 
[{"avatar":"sample value","bio":"sample value","facebook":"sample value","language":"sample value","linkedin":"sample value","name":"sample value","rating":"sample value","time_created":"sample value","twitter":"sample value","url":"sample value","user_id":"sample value"}]

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/marketplace/{marketplace_id}/users?page=A-VALUE&select=A-VALUE&not_select=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getMyItems (GET) 

Retrieve a list of your items.

Parameters

access_token
STRING
This method requires a valid access_token. You can obtain your personal access token by logging in here: https://tinypay.me/oauth/your_token or request permission from another user with "getOAuthPermission".

For example: "ilkOk4bHj8huCtJnAUx0wY5KHQNnK99uJ8ygN3P1fk... (84 chars)"

select(optional)
STRING
Use this property to save data by selecting the properties you'd ONLY like to return. This comes in handy when you're developing mobile applications. Separate multiple properties with commas. Use the dot notation to select inner elements.

For example: "item_id,title,description,images.orginal"

not_select(optional)
STRING
Use this property to save data by NOT selecting some of the properties. This comes in handy when you're developing mobile applications. Separate multiple properties with commas. Use the dot notation to select inner elements.

For example: "charity,shipment_costs,user.bio"

page(optional)
NONE

This parameter field has no description

limit(optional)
NONE

This parameter field has no description

marketplace_id(optional)
NONE

This parameter field has no description

Results (Array)

charity (optional)
OBJECT
Charity details (if present).
charity_id (optional)
STRING
The ID of the charity

For example: "W0NFmK"

percentage (optional)
NUMBER
The percentage of the sales that gets donated to the charity. 0.1 (1%) to 1 (100%).

For example: "0.2"

title (optional)
STRING
The title of the charity

For example: "Music For Relief"

description (optional)
STRING
The description of the charity

For example: "Founded by Linkin Park in 2005, Music For Relief is a non-profit dedicated to natural disaster relief and mitigation around the world."

link (optional)
STRING
The website of the charity

For example: "http://www.musicforrelief.org"

twitter (optional)
STRING
The Twitter username of the charity. Use this to send tweets!

For example: "@MusicForRelief"

country (optional)
STRING
The country where this item is placed

For example: "US"

currency (optional)
STRING
The currency of this item

For example: "EUR"

description (optional)
STRING
The description of this item.

For example: "A portable and lightweight iPad Stand."

file (optional)
OBJECT
Information about the downloadable file (if present).
token (optional)
STRING
The file token is the identifier of the uploaded file and the result of the "uploadFile" method.

For example: "OUSffKKAEKt1TVM3Uetpu7SdMuOWoKxt"

name (optional)
STRING
The name of the downloadable file

For example: "The_Wooden_Ipad_Stand_Story.pdf.zip"

size (optional)
STRING
The file size of the downloadable file

For example: "1.46 MB"

thumbnail (optional)
STRING
Image only: thumbnail of the uploaded image.

For example: "http://img.tinypay.me/DDo7VJBn4CcuwiScDb0..."

geo (optional)
OBJECT
Geographical coordinates of this item
latitude (optional)
NUMBER
The latitude coordinate of this item

For example: "52.233"

longitude (optional)
NUMBER
The longitude coordinate of this item

For example: "5.183"

images (optional)
array of OBJECT
List of item images (if present).
original (optional)
STRING
Original size of the image.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

large (optional)
STRING
Large size of the image. Maximum dimensions: 800 x 600 px.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

medium (optional)
STRING
Medium size of the image. Maximum dimensions: 640 x 480 px.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

small (optional)
STRING
Small size of the image. Maximum dimensions: 320 x 420 px.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

xsmall (optional)
STRING
Extra small size of the image. Maximum dimensions: 180 x 135 px.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

xxsmall (optional)
STRING
Extremely small size of the image. Maximum dimensions: 90 x 68 px.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

item_id (optional)
STRING
The ID of the item

For example: "p18t0qt"

language (optional)
STRING
The language of this item

For example: "en-us"

marketplace_id (optional)
NONE

This result field has no description

price (optional)
NUMBER
The price of an item

For example: "14.99"

quantity (optional)
NUMBER
The quantity of an item. -1 stands for: unlimited. 0 stands for: sold out.

For example: "20"

shipment_costs (optional)
array of OBJECT
List of shipment areas and corresponding shipment costs. Use the "getShipmentCountries" method to fully expand the list of all shipment countries within regions.
area (optional)
STRING
The shipment area code.

For example: "european_union"

shipment_cost (optional)
NUMBER
The shipment costs to that area.

For example: "4.90"

is_region (optional)
BOOLEAN
Tells you whether this area is a region (which consists of multiple countries) or an individual country (2 letter ISO 3166-1 code).

For example: "true"

title (optional)
NONE

This result field has no description

shipment_costs_per_item (optional)
BOOLEAN
Whether this items charges shipment costs per item instead of per order.

For example: "1"

tags (optional)
array of STRING
List of tags of the item. Tags play an important role in the "getSearch" method.

For example: "game"

thumbnail (optional)
STRING
The thumbnail version of the image. Includes the price of the item.

For example: "http://img.tinypay.me/btn/p18t0qt"

time_created (optional)
NUMBER
The UNIX timestamp of when this item was created

For example: "1296330318"

title (optional)
STRING
The title of the item

For example: "The Ultra Portable Wooden iPad Stand"

url (optional)
STRING
The URL of the item

For example: "http://tinypay.me/~gwb3M6U"

user (optional)
OBJECT
The seller of this item
user_id (optional)
STRING
The ID of the user

For example: "soV3nwLn"

url (optional)
STRING
The URL of the user's profile page

For example: "http://tinypay.me/uncle-joe"

name (optional)
STRING
The name of the user

For example: "Uncle Joe"

avatar (optional)
STRING
The URL of the user's avatar

For example: "http://img.tinypay.me/user/s7pW3..."

bio (optional)
STRING
The 'about me' description of the user

For example: "Hi, welcome to my shop! Contact me if you have any questions."

time_created (optional)
NUMBER
The UNIX timestamp of when this user was created

For example: "1290853844"

language (optional)
STRING
The preferred language of the user

For example: "en-us"

rating (optional)
NUMBER
The rating of the user on a scale of 1 to 5. 0 stands for: no rating yet.

For example: "3.8"

facebook (optional)
NONE

This result field has no description

linkedin (optional)
NONE

This result field has no description

twitter (optional)
NONE

This result field has no description

widget_url (optional)
STRING
The widget url of an Embed.ly supported service. See http://embed.ly/providers for the entire list.

For example: "http://soundcloud.com/titanoz/lily-bizarre-fallen-titanoz-remix"

Example

JSON 
[{"charity":{"charity_id":"W0NFmK","percentage":0.2,"title":"Music For Relief","description":"Founded by Linkin Park in 2005, Music For Relief is a non-profit dedicated to natural disaster relief and mitigation around the world.","link":"http://www.musicforrelief.org","twitter":"@MusicForRelief"},"country":"US","currency":"EUR","description":"A portable and lightweight iPad Stand.","file":{"token":"OUSffKKAEKt1TVM3Uetpu7SdMuOWoKxt","name":"The_Wooden_Ipad_Stand_Story.pdf.zip","size":"1.46 MB","thumbnail":"http://img.tinypay.me/DDo7VJBn4CcuwiScDb0..."},"geo":{"latitude":52.233,"longitude":5.183},"images":[{"original":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx...","large":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx...","medium":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx...","small":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx...","xsmall":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx...","xxsmall":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."}],"item_id":"p18t0qt","language":"en-us","marketplace_id":"sample value","price":14.99,"quantity":20,"shipment_costs":[{"area":"european_union","shipment_cost":4.90,"is_region":true,"title":"sample value"}],"shipment_costs_per_item":1,"tags":["game"],"thumbnail":"http://img.tinypay.me/btn/p18t0qt","time_created":1296330318,"title":"The Ultra Portable Wooden iPad Stand","url":"http://tinypay.me/~gwb3M6U","user":{"user_id":"soV3nwLn","url":"http://tinypay.me/uncle-joe","name":"Uncle Joe","avatar":"http://img.tinypay.me/user/s7pW3...","bio":"Hi, welcome to my shop! Contact me if you have any questions.","time_created":1290853844,"language":"en-us","rating":3.8,"facebook":"sample value","linkedin":"sample value","twitter":"sample value"},"widget_url":"http://soundcloud.com/titanoz/lily-bizarre-fallen-titanoz-remix"}]

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/me/items?access_token=A-VALUE&select=A-VALUE&not_select=A-VALUE&page=A-VALUE&limit=A-VALUE&marketplace_id=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getMyMarketplaces (GET) 

Retrieve a list of your Marketplaces

Parameters

access_token
STRING
This method requires a valid access_token. You can obtain your personal access token with "getMyAccessToken"  or request permission from another user with "getOAuthPermission".

For example: "ilkOk4bHj8huCtJnAUx0wY5KHQNnK99uJ8ygN3P1fk... (84 chars)"

select(optional)
STRING
Use this property to save data by selecting the properties you'd ONLY like to return. This comes in handy when you're developing mobile applications. Separate multiple properties with commas. Use the dot notation to select inner elements.

For example: "title,url,categories.title,logo"

not_select(optional)
STRING
Use this property to save data by NOT selecting some of the properties. This comes in handy when you're developing mobile applications. Separate multiple properties with commas. Use the dot notation to select inner elements.

For example: "description,categories.category_id,url"

Results (Array)

categories (optional)
array of OBJECT
List of marketplace categories (if present).
category_id
STRING
The ID of the marketplace category.

For example: "cENVHVhE"

title
STRING
The title of the marketplace category.

For example: "Xbox 360 Games"

url
STRING
The URL of the marketplace category

For example: "http://xboxworld.tinypay.me/#xbox-360"

description (optional)
STRING
The description of the marketplace.

For example: "Sell your Xbox 360, Wii, Playstation 3, PC games and your soul!"

logo (optional)
STRING
The URL of the logo of the marketplace.

For example: "http://img.tinypay.me/marketplace/mh9u..."

marketplace_id (optional)
STRING
The ID of the marketplace

For example: "mteY4kEZ"

title (optional)
STRING
The title of the marketplace

For example: "Xboxworld"

url (optional)
STRING
The URL of the marketplace

For example: "http://xboxworld.tinypay.me"

Example

JSON 
[{"categories":[{"category_id":"cENVHVhE","title":"Xbox 360 Games","url":"http://xboxworld.tinypay.me/#xbox-360"}],"description":"Sell your Xbox 360, Wii, Playstation 3, PC games and your soul!","logo":"http://img.tinypay.me/marketplace/mh9u...","marketplace_id":"mteY4kEZ","title":"Xboxworld","url":"http://xboxworld.tinypay.me"}]

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/me/marketplaces?access_token=A-VALUE&select=A-VALUE&not_select=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getMyOrders (GET) 

Retrieve a list of your orders.

Parameters

access_token
STRING
This method requires a valid access_token. You can obtain your personal access token by logging in here: https://tinypay.me/oauth/your_token or request permission from another user with "getOAuthPermission" (requires 'view_orders' permission).

For example: "ilkOk4bHj8huCtJnAUx0wY5KHQNnK99uJ8ygN3P1fk... (84 chars)"

select(optional)
STRING
Use this property to save data by selecting the properties you'd ONLY like to return. This comes in handy when you're developing mobile applications. Separate multiple properties with commas. Use the dot notation to select inner elements.

For example: "currency,has_file,item_id"

not_select(optional)
STRING
Use this property to save data by NOT selecting some of the properties. This comes in handy when you're developing mobile applications. Separate multiple properties with commas. Use the dot notation to select inner elements.

For example: "quantity,buyer.name"

Results (Array)

buyer
OBJECT
Details of the buyer
name
STRING
Name of the buyer

For example: "Steve Jobs"

email
STRING
E-mail address of the buyer

For example: "sjobs@apple.com"

address_line_1
STRING
First address line of the shipment address

For example: "1 Infinite Loop"

address_line_2
STRING
The second address line of the shipment address

For example: "CEO's office"

postal_zip_code
STRING
The postal or zip code of the shipment address

For example: "95014"

city
STRING
The city of the shipment address

For example: "Cupertino"

state_province
STRING
The state or province of the shipment address

For example: "CA"

country
STRING
The country of the shipment address

For example: "US"

comment
STRING
The comment of the buyer

For example: "Hi, please make sure you ring twice."

currency
STRING
The currency of this order

For example: "USD"

has_file
BOOLEAN
Tells you if the buyer should receive a download link to the attached file

For example: "true"

item_id
STRING
The ID of the item that has been ordered

For example: "PBsgWR7"

item_price
NUMBER
The price of the item at the time this order was placed

For example: "14.99"

order_id
STRING
The ID of the order

For example: "oCUZNrkCSrmobzSWOVhREdQ0V99RhtxJ"

quantity
NUMBER
The quantity of the order

For example: "2"

shipment_costs
NUMBER
The shipment costs for this order (if present).

For example: "2.50"

status
STRING
The status of the order. Status definitions: 'created': created, but not finished. 'cancelled': buyer cancelled the payment. 'pending': payment is finished, but not cleared by PayPal yet (e.g. eChecks). 'completed': payment is successfully sent to the seller and the order is completed.

For example: "completed"

time
NUMBER
The UNIX timestamp of the placement of this order

For example: "1297264411"

total_order_price
NUMBER
The total price of the order (including shipment costs).

For example: "32.48"

Example

JSON 
[{"buyer":{"name":"Steve Jobs","email":"sjobs@apple.com","address_line_1":"1 Infinite Loop","address_line_2":"CEO's office","postal_zip_code":"95014","city":"Cupertino","state_province":"CA","country":"US","comment":"Hi, please make sure you ring twice."},"currency":"USD","has_file":true,"item_id":"PBsgWR7","item_price":14.99,"order_id":"oCUZNrkCSrmobzSWOVhREdQ0V99RhtxJ","quantity":2,"shipment_costs":2.50,"status":"completed","time":1297264411,"total_order_price":32.48}]

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/me/orders?access_token=A-VALUE&select=A-VALUE&not_select=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getMyProfile (GET) 

Retrieve your user details. 

It is not (yet) possible to update these details through the API. Go to the settings panel at tinypay.me to change your profile information.

Parameters

access_token
STRING
This method requires a valid access_token. You can obtain your personal access token by logging in here: https://tinypay.me/oauth/your_token or request permission from another user with "getOAuthPermission".

For example: "ilkOk4bHj8huCtJnAUx0wY5KHQNnK99uJ8ygN3P1fk... (84 chars)"

select(optional)
STRING
Use this property to save data by selecting the properties you'd ONLY like to return. This comes in handy when you're developing mobile applications. Separate multiple properties with commas. Use the dot notation to select inner elements.

For example: "name,url,user_id"

not_select(optional)
STRING
Use this property to save data by NOT selecting some of the properties. This comes in handy when you're developing mobile applications. Separate multiple properties with commas. Use the dot notation to select inner elements.

For example: "rating,bio"

Results

avatar (optional)
STRING
The URL of your avatar

For example: "http://img.tinypay.me/user/s7pW3..."

bio (optional)
STRING
Your 'about me' description

For example: "Hi, welcome to my shop! Contact me if you have any questions."

facebook (optional)
NONE

This result field has no description

language (optional)
STRING
Your preferred language

For example: "en-us"

linkedin (optional)
NONE

This result field has no description

name (optional)
STRING
Your name

For example: "Uncle Joe"

rating (optional)
NUMBER
Your rating on a scale of 1 to 5. 0 stands for: no rating yet.

For example: "3.8"

time_created (optional)
NUMBER
The UNIX timestamp of when your account was created

For example: "1290853844"

twitter (optional)
NONE

This result field has no description

url (optional)
STRING
Your profile page URL

For example: "http://tinypay.me/uncle-joe"

user_id (optional)
STRING
Your user ID

For example: "soV3nwLn"

Example

JSON 
{"avatar":"http://img.tinypay.me/user/s7pW3...","bio":"Hi, welcome to my shop! Contact me if you have any questions.","facebook":"sample value","language":"en-us","linkedin":"sample value","name":"Uncle Joe","rating":3.8,"time_created":1290853844,"twitter":"sample value","url":"http://tinypay.me/uncle-joe","user_id":"soV3nwLn"}

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/me?access_token=A-VALUE&select=A-VALUE&not_select=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getOAuthAccessToken (GET) 

Retrieve the access token with the code provided from the "getOAuthPermission" callback.

Parameters

access_token
STRING
This method requires a valid personal access_token. You can obtain your personal access token by logging in here: https://tinypay.me/oauth/your_token

Note: you cannot use other access tokens than your own personal access token.

For example: "ilkOk4bHj8huCtJnAUx0wY5KHQNnK99uJ8ygN3P1fk... (84 chars)"

code
STRING
The code you retrieved from the "getOAuthPermission" callback

For example: "dcaFCAw2d1HmWggcvHDDFaJaDsdx1oKl"

Results

access_token
STRING
The access token for another user. You can use this access token in name of that user in almost all protected methods.

For example: "ilkOk4bHj8huCtJnAUx0wY5KHQNnK99uJ8ygN3P1fk... (84 chars)"

Example

JSON 
{"access_token":"ilkOk4bHj8huCtJnAUx0wY5KHQNnK99uJ8ygN3P1fk... (84 chars)"}

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/oauth/access_token?access_token=A-VALUE&code=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getOAuthPermission (GET) 

Request access permission from another user. 

This method uses the OAuth 2.0 authentication protocol.

Parameters

marketplace_id
STRING
The ID of the marketplace you want to request permission for.

For example: "mN4UIW1W"

redirect_uri
STRING
The return URL the user should be redirected back to.

For example: "http://example.com/return"

scope(optional)
STRING
Ask the user for specific permissions for protected methods. Available permissions are: 'create_items', 'edit_items', 'delete_items', 'view_orders'. Separate multiple permissions by comma.

For example: "create_items,edit_items,view_orders"

state(optional)
STRING
Specify a certain variable that should be returned upon redirect. Use this to maintain state with your own application between the request and callback.

For example: "ABC123"

Results

oauth_url
STRING
The OAuth URL you should redirect the user of your application to, to initiate the permission flow.

For example: "https://tinypay.me/oauth/.."

Example

JSON 
{"oauth_url":"https://tinypay.me/oauth/.."}

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/oauth/permission?marketplace_id=A-VALUE&redirect_uri=A-VALUE&scope=A-VALUE&state=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getOrderStatus (GET) 

Retrieve the status of an order.

Parameters

order_id
STRING
The ID of the order.

For example: "oVlxpIK3jWTOlMl3BOJ4qDCpjBcWSqA5"

Results

status
STRING
The status of the order. Status definitions: 'created': created, but not finished. 'cancelled': buyer cancelled the payment. 'pending': payment is finished, but not cleared by PayPal yet (e.g. eChecks). 'completed': payment is successfully sent to the seller and the order is completed.

For example: "completed"

Example

JSON 
{"status":"completed"}

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/order/{order_id}
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getRegions (GET) 

View all supported regions.

Parameters

This method has no parameters

Results (Array)

code
STRING
The region code.

For example: "european_union"

title
STRING
The title of the region

For example: "European Union"

Example

JSON 
[{"code":"european_union","title":"European Union"}]

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/regions
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getSearch (GET) 

Search in all items.

Parameters

q(optional)
STRING
The query string of your search.

For example: "iphone"

items(optional)
NUMBER
The number of items you want to return

For example: "12"

start(optional)
STRING
The offset of the search results. Default: 0. Max: 499.

For example: "10"

file(optional)
BOOLEAN
Whether the items should contain a file download or not. Omit this parameter to choose both.

For example: "false"

charity(optional)
BOOLEAN
Whether the items should donate to a charity or not. Omit this parameter to choose both.

For example: "true"

image(optional)
BOOLEAN
Whether the items should contain at least one image or not. Omit this parameter to choose both.

For example: "true"

video(optional)
BOOLEAN
Whether the items should contain a video url or not. Omit this parameter to choose both.

For example: "false"

shipment(optional)
BOOLEAN
Whether the items are shipped to at least one location or not. Omit this parameter to choose both.

For example: "false"

min_price(optional)
NUMBER
The minimum price of the items.

For example: "10"

max_price(optional)
NUMBER
The maximum price of the items

For example: "50"

country(optional)
STRING
Restrict your search to a certain country. Omit this parameter to search in all countries. Use the "getCountries" method to get a list of all supported countries.

For example: "FR"

currency(optional)
STRING
Restrict your search to a certain currency. Omit this parameter to search in all currencies. Use the "getCurrency" method to get a list of all supported currencies.

For example: "EUR"

lang(optional)
STRING
Restrict your search to a certain language. Omit this parameter to search in all languages. Use the "getLanguages" method to get a list of all supported currencies.

For example: "en-us"

tag(optional)
STRING
Restrict your search to a certain tag. Omit this parameter to search in all tags.

For example: "shirt"

tags(optional)
STRING
Restrict your search to a list of tags. Returns the items that at least contain one of these tags. Omit this parameter to search in all tags. Separate multiple tags with a comma.

For example: "white,shirt,hand-made"

sort_by(optional)
STRING
Sort the items by 'price' or 'time'. Omit this parameter to return results at "best relevance". Our search algorithm will then decide on a number of parameters on how to rank results.

For example: "price"

select(optional)
STRING
Use this property to save data by selecting the properties you'd ONLY like to return. This comes in handy when you're developing mobile applications. Separate multiple properties with commas. Use the dot notation to select inner elements.

For example: "item_id,title,description,images.orginal"

not_select(optional)
STRING
Use this property to save data by NOT selecting some of the properties. This comes in handy when you're developing mobile applications. Separate multiple properties with commas. Use the dot notation to select inner elements.

For example: "charity,shipment_costs,user.bio"

mylon(optional)
NUMBER
Your longitude coordinates. (-180 to 180).

For example: "-122.395456"

mylat(optional)
NUMBER
Your latitude coordinates (-90 to 90).

For example: "37.789644"

range(optional)
NUMBER
The radius in units defined by "unit".

For example: "1500"

unit(optional)
STRING
The units in which radius is defined. "mi" (miles), "km" (kilometer),  "m" (meter), "yd" (yard) and "ft" (feet) are allowed.

For example: "mi"

Results

results
array of OBJECT
List of search results
item_id (optional)
STRING
The ID of the item

For example: "7ZFnSVB"

item_url (optional)
STRING
The URL of the item

For example: "http://tinypay.me/~zqNZTq7"

title (optional)
STRING
The title of the item

For example: "White Monkey Shirt"

description (optional)
STRING
The description of the item

For example: "Get them now while they're white!"

price (optional)
NUMBER
The price of the item

For example: "14.99"

currency (optional)
STRING
The currency of the item

For example: "USD"

user_id (optional)
STRING
The ID of the seller of this item.

For example: "sFDlZE2V"

user_name (optional)
STRING
The name of the seller

For example: "Uncle Joe"

user_url (optional)
STRING
The URL of the profile page of the seller

For example: "http://tinypay.me/unclejoe"

user (optional)
OBJECT

This result field has no description

user_id (optional)
NONE

This result field has no description

url (optional)
NONE

This result field has no description

name (optional)
NONE

This result field has no description

avatar (optional)
NONE

This result field has no description

bio (optional)
NONE

This result field has no description

time_created (optional)
NONE

This result field has no description

language (optional)
NONE

This result field has no description

rating (optional)
NONE

This result field has no description

facebook (optional)
NONE

This result field has no description

linkedin (optional)
NONE

This result field has no description

twitter (optional)
NONE

This result field has no description

marketplace_id (optional)
STRING
The ID of the marketplace where this item was placed on.

For example: "m7rZp52O"

category_id (optional)
STRING
The ID of the marketplace category where this item was placed in

For example: "coN3hkDv"

thumbnail (optional)
STRING
The thumbnail version of the image. Includes the price of the item.

For example: "http://img.tinypay.me/btn/7ZFnSVB"

image (optional)
OBJECT
The default image of the item. Only small versions are available within this method.
original (optional)
STRING
N/a
large (optional)
STRING
N/a
medium (optional)
STRING
N/a
small (optional)
STRING
Small size of the image. Maximum dimensions: 320 x 420 px.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

xsmall (optional)
STRING
Extra small size of the image. Maximum dimensions: 180 x 135 px.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

xxsmall (optional)
STRING
Extremely small size of the image. Maximum dimensions: 90 x 68 px.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

geo (optional)
OBJECT
Geographical coordinates of this item
latitude (optional)
NUMBER
The latitude coordinate of this item

For example: "52.233"

longitude (optional)
NUMBER
The longitude coordinate of this item

For example: "5.183"

results_count
NUMBER
The amount of results included in this result set.

For example: "16"

results_from
NUMBER
The number of the beginning of this result set.

For example: "24"

results_to
NUMBER
The number of the end of this result set.

For example: "40"

total_count
NUMBER
The total number of items for this query. This number cannot be higher than 500.

For example: "400"

Example

JSON 
{"results":[{"item_id":"7ZFnSVB","item_url":"http://tinypay.me/~zqNZTq7","title":"White Monkey Shirt","description":"Get them now while they're white!","price":14.99,"currency":"USD","user_id":"sFDlZE2V","user_name":"Uncle Joe","user_url":"http://tinypay.me/unclejoe","user":{"user_id":"sample value","url":"sample value","name":"sample value","avatar":"sample value","bio":"sample value","time_created":"sample value","language":"sample value","rating":"sample value","facebook":"sample value","linkedin":"sample value","twitter":"sample value"},"marketplace_id":"m7rZp52O","category_id":"coN3hkDv","thumbnail":"http://img.tinypay.me/btn/7ZFnSVB","image":{"original":"sample value","large":"sample value","medium":"sample value","small":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx...","xsmall":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx...","xxsmall":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."},"geo":{"latitude":52.233,"longitude":5.183}}],"results_count":16,"results_from":24,"results_to":40,"total_count":400}

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/search?q=A-VALUE&items=A-VALUE&start=A-VALUE&file=A-VALUE&charity=A-VALUE&image=A-VALUE&video=A-VALUE&shipment=A-VALUE&min_price=A-VALUE&max_price=A-VALUE&country=A-VALUE&currency=A-VALUE&lang=A-VALUE&tag=A-VALUE&tags=A-VALUE&sort_by=A-VALUE&select=A-VALUE&not_select=A-VALUE&mylon=A-VALUE&mylat=A-VALUE&range=A-VALUE&unit=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getSearchSuggestions (GET) 

Retrieve autocomplete search suggestions for your query string.

Parameters

q(optional)
STRING
Your (partial) query string.

For example: "play.."

Results (Array)

suggestions
STRING
Array of suggestions

For example: "play, player, players, playing, playstation-3"

Example

JSON 
[{"suggestions":"play, player, players, playing, playstation-3"}]

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/search/suggestions?q=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getShipmentCountries (GET) 

Retrieve the full list of shipment countries and the shipment costs for a certain item.

Parameters

item_id
STRING
The ID of the item.

For example: "oGNtWyt"

language(optional)
NONE

This parameter field has no description

Results (Array)

area (optional)
STRING
The 2 letter ISO 3166-1 country code.

For example: "US"

is_region (optional)
BOOLEAN
Only item: tells you whether this area is a region. (Which is never the case in this method).

For example: "false"

shipment_cost (optional)
NUMBER
The shipment costs to this country.

For example: "4.90"

title (optional)
NONE

This result field has no description

Example

JSON 
[{"area":"US","is_region":false,"shipment_cost":4.90,"title":"sample value"}]

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/item/{item_id}/shipment?language=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getUserItems (GET) 

Retrieve a list of items of an user.

Parameters

user_id
STRING
The ID of the user. You can use internal IDs (e.g. "soV3nwLn") or public IDs (e.g. "melvinmt").

For example: "soV3nwLn"

select(optional)
STRING
Use this property to save data by selecting the properties you'd ONLY like to return. This comes in handy when you're developing mobile applications. Separate multiple properties with commas. Use the dot notation to select inner elements.

For example: "item_id,title,description,images.orginal"

not_select(optional)
STRING
Use this property to save data by NOT selecting some of the properties. This comes in handy when you're developing mobile applications. Separate multiple properties with commas. Use the dot notation to select inner elements.

For example: "charity,shipment_costs,user.bio"

page(optional)
NONE

This parameter field has no description

limit(optional)
NONE

This parameter field has no description

marketplace_id(optional)
NONE

This parameter field has no description

Results (Array)

charity (optional)
OBJECT
Charity details (if present).
charity_id (optional)
STRING
The ID of the charity

For example: "W0NFmK"

percentage (optional)
NUMBER
The percentage of the sales that gets donated to the charity. 0.1 (1%) to 1 (100%).

For example: "0.2"

title (optional)
STRING
The title of the charity

For example: "Music For Relief"

description (optional)
STRING
The description of the charity

For example: "Founded by Linkin Park in 2005, Music For Relief is a non-profit dedicated to natural disaster relief and mitigation around the world."

link (optional)
STRING
The website of the charity

For example: "http://www.musicforrelief.org"

twitter (optional)
STRING
The Twitter username of the charity. Use this to send tweets!

For example: "@MusicForRelief"

country (optional)
STRING
The country where this item is placed

For example: "US"

currency (optional)
STRING
The currency of this item

For example: "EUR"

description (optional)
STRING
The description of this item.

For example: "A portable and lightweight iPad Stand."

file (optional)
OBJECT
Downloadable file details (if present).
token (optional)
STRING
The file token is the identifier of the uploaded file and the result of the "uploadFile" method.

For example: "OUSffKKAEKt1TVM3Uetpu7SdMuOWoKxt"

name (optional)
STRING
The name of the downloadable file

For example: "The_Wooden_Ipad_Stand_Story.pdf.zip"

size (optional)
STRING
The file size of the downloadable file

For example: "1.46 MB"

thumbnail (optional)
STRING
Image only: thumbnail of the uploaded image.

For example: "http://img.tinypay.me/DDo7VJBn4CcuwiScDb0..."

geo (optional)
OBJECT
Geographical coordinates of this item
latitude (optional)
NUMBER
The latitude coordinate of this item

For example: "52.233"

longitude (optional)
NUMBER
The longitude coordinate of this item

For example: "5.183"

images (optional)
array of OBJECT
List of item images (if present).
original (optional)
STRING
Original size of the image.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

large (optional)
STRING
Large size of the image. Maximum dimensions: 800 x 600 px.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

medium (optional)
STRING
Medium size of the image. Maximum dimensions: 640 x 480 px.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

small (optional)
STRING
Small size of the image. Maximum dimensions: 320 x 420 px.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

xsmall (optional)
STRING
Extra small size of the image. Maximum dimensions: 180 x 135 px.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

xxsmall (optional)
STRING
Extremely small size of the image. Maximum dimensions: 90 x 68 px.

For example: "http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."

item_id (optional)
STRING
The ID of the item

For example: "p18t0qt"

language (optional)
STRING
The language of this item

For example: "en-us"

marketplace_id (optional)
NONE

This result field has no description

price (optional)
NUMBER
The price of an item

For example: "14.99"

quantity (optional)
NUMBER
The quantity of an item. -1 stands for: unlimited. 0 stands for: sold out.

For example: "20"

shipment_costs (optional)
array of OBJECT
List of shipment areas and corresponding shipment costs. Use the "getShipmentCountries" method to fully expand the list of all shipment countries within regions.
area (optional)
STRING
The shipment area code.

For example: "european_union"

shipment_cost (optional)
NUMBER
The shipment costs to that area.

For example: "4.90"

is_region (optional)
BOOLEAN
Tells you whether this area is a region (which consists of multiple countries) or an individual country (2 letter ISO 3166-1 code).

For example: "true"

title (optional)
NONE

This result field has no description

shipment_costs_per_item (optional)
BOOLEAN
Whether this items charges shipment costs per item instead of per order.

For example: "1"

tags (optional)
array of STRING
List of tags of the item. Tags play an important role in the "getSearch" method.

For example: "game"

thumbnail (optional)
STRING
The thumbnail version of the image. Includes the price of the item.

For example: "http://img.tinypay.me/btn/p18t0qt"

time_created (optional)
NUMBER
The UNIX timestamp of when this item was created

For example: "1296330318"

title (optional)
STRING
The title of the item

For example: "The Ultra Portable Wooden iPad Stand"

url (optional)
STRING
The URL of the item

For example: "http://tinypay.me/~gwb3M6U"

user (optional)
OBJECT
The seller of this item
user_id (optional)
STRING
The ID of the user

For example: "soV3nwLn"

url (optional)
STRING
The URL of the user's profile page

For example: "http://tinypay.me/uncle-joe"

name (optional)
STRING
The name of the user

For example: "Uncle Joe"

avatar (optional)
STRING
The URL of the user's avatar

For example: "http://img.tinypay.me/user/s7pW3..."

bio (optional)
STRING
The 'about me' description of the user

For example: "Hi, welcome to my shop! Contact me if you have any questions."

time_created (optional)
NUMBER
The UNIX timestamp of when this user was created

For example: "1290853844"

language (optional)
STRING
The preferred language of the user

For example: "en-us"

rating (optional)
NUMBER
The rating of the user on a scale of 1 to 5. 0 stands for: no rating yet.

For example: "3.8"

facebook (optional)
NONE

This result field has no description

linkedin (optional)
NONE

This result field has no description

twitter (optional)
NONE

This result field has no description

widget_url (optional)
STRING
The widget url of an Embed.ly supported service. See http://embed.ly/providers for the entire list.

For example: "http://soundcloud.com/titanoz/lily-bizarre-fallen-titanoz-remix"

Example

JSON 
[{"charity":{"charity_id":"W0NFmK","percentage":0.2,"title":"Music For Relief","description":"Founded by Linkin Park in 2005, Music For Relief is a non-profit dedicated to natural disaster relief and mitigation around the world.","link":"http://www.musicforrelief.org","twitter":"@MusicForRelief"},"country":"US","currency":"EUR","description":"A portable and lightweight iPad Stand.","file":{"token":"OUSffKKAEKt1TVM3Uetpu7SdMuOWoKxt","name":"The_Wooden_Ipad_Stand_Story.pdf.zip","size":"1.46 MB","thumbnail":"http://img.tinypay.me/DDo7VJBn4CcuwiScDb0..."},"geo":{"latitude":52.233,"longitude":5.183},"images":[{"original":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx...","large":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx...","medium":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx...","small":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx...","xsmall":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx...","xxsmall":"http://img.tinypay.me/lHE1VNsIfcGlymw0Qtx..."}],"item_id":"p18t0qt","language":"en-us","marketplace_id":"sample value","price":14.99,"quantity":20,"shipment_costs":[{"area":"european_union","shipment_cost":4.90,"is_region":true,"title":"sample value"}],"shipment_costs_per_item":1,"tags":["game"],"thumbnail":"http://img.tinypay.me/btn/p18t0qt","time_created":1296330318,"title":"The Ultra Portable Wooden iPad Stand","url":"http://tinypay.me/~gwb3M6U","user":{"user_id":"soV3nwLn","url":"http://tinypay.me/uncle-joe","name":"Uncle Joe","avatar":"http://img.tinypay.me/user/s7pW3...","bio":"Hi, welcome to my shop! Contact me if you have any questions.","time_created":1290853844,"language":"en-us","rating":3.8,"facebook":"sample value","linkedin":"sample value","twitter":"sample value"},"widget_url":"http://soundcloud.com/titanoz/lily-bizarre-fallen-titanoz-remix"}]

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/user/{user_id}/items?select=A-VALUE&not_select=A-VALUE&page=A-VALUE&limit=A-VALUE&marketplace_id=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getUserProfile (GET) 

View the details of an user's profile.

Parameters

user_id
STRING
The ID of the user. You can use internal IDs (e.g. "soV3nwLn") or public IDs (e.g. "melvinmt").

For example: "soV3nwLn"

select(optional)
STRING
Use this property to save data by selecting only the properties you'd like to return. This comes in handy when you're developing mobile applications. Separate multiple properties with commas.

For example: "name,url,user_id"

not_select(optional)
STRING
Use this property to save data by NOT selecting some of the properties. This comes in handy when you're developing mobile applications. Separate multiple properties with commas. Use the dot notation to select inner elements.

For example: "rating,bio"

Results

avatar (optional)
STRING
The URL of the user's avatar

For example: "http://img.tinypay.me/user/s7pW3..."

bio (optional)
STRING
The 'about me' description of the user

For example: "Hi, welcome to my shop! Contact me if you have any questions."

facebook (optional)
NONE

This result field has no description

language (optional)
STRING
The preferred language of the user

For example: "en-us"

linkedin (optional)
NONE

This result field has no description

name (optional)
STRING
The name of the user

For example: "Uncle Joe"

rating (optional)
NUMBER
The rating of the user on a scale of 1 to 5. 0 stands for: no rating yet.

For example: "3.8"

time_created (optional)
NUMBER
The UNIX timestamp of when this user was created

For example: "1290853844"

twitter (optional)
NONE

This result field has no description

url (optional)
STRING
The URL of the user's profile page

For example: "http://tinypay.me/uncle-joe"

user_id (optional)
STRING
The ID of the user

For example: "soV3nwLn"

Example

JSON 
{"avatar":"http://img.tinypay.me/user/s7pW3...","bio":"Hi, welcome to my shop! Contact me if you have any questions.","facebook":"sample value","language":"en-us","linkedin":"sample value","name":"Uncle Joe","rating":3.8,"time_created":1290853844,"twitter":"sample value","url":"http://tinypay.me/uncle-joe","user_id":"soV3nwLn"}

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/user/{user_id}?select=A-VALUE&not_select=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

getWidget (GET) 

Retrieve widget embed code from item

Parameters

item_id
STRING
Item ID

For example: "bZ25M4z"

maxwidth(optional)
NUMBER
Maximum width of embed in pixels

For example: "388"

Results

html
NONE
HTML embed code

For example: "<object height="81" width="388"> <param name="movie" value="http://player.soundcloud.com/player.swf?url=http%3A%2F%2Fapi.soundcloud.com%2Ftracks%2F21538998"></param><param name="allowscriptaccess" value="always"></param><embed allowscriptaccess="always" height="81" src="http://player.soundcloud.com/player.swf?url=http%3A%2F%2Fapi.soundcloud.com%2Ftracks%2F21538998" type="application/x-shockwave-flash" width="388"></embed></object>"

Example

JSON 
{"html":"<object height=\"81\" width=\"388\"> <param name=\"movie\" value=\"http://player.soundcloud.com/player.swf?url=http%3A%2F%2Fapi.soundcloud.com%2Ftracks%2F21538998\"></param><param name=\"allowscriptaccess\" value=\"always\"></param><embed allowscriptaccess=\"always\" height=\"81\" src=\"http://player.soundcloud.com/player.swf?url=http%3A%2F%2Fapi.soundcloud.com%2Ftracks%2F21538998\" type=\"application/x-shockwave-flash\" width=\"388\"></embed></object>"}

JSON (Learn how)

GET https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/item/{item_id}/widget?maxwidth=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

updateItem (POST) 

Update an existing item. Note: only provide the parameters that should be changed.

Parameters

access_token
STRING
This method requires a valid access_token. You can obtain your personal access token by logging in here: https://tinypay.me/oauth/your_token or request permission from another user with "getOAuthPermission" (requires 'edit_item' permission). The access token user has to be the owner of this item to be able to perform this action.

For example: "ilkOk4bHj8huCtJnAUx0wY5KHQNnK99uJ8ygN3P1fk... (84 chars)"

item_id
STRING
The ID of the item that needs to be updated.

For example: "k3UKyTp"

title(optional)
STRING
The title of your item

For example: "Monkey T-shirt (White)"

currency(optional)
STRING
The currency of your item. You can find all supported currencies with the "getCurrencies" method.

For example: "USD"

price(optional)
NUMBER
The price of your item.

For example: "14.99"

description(optional)
STRING
The description of your item. The better your description, the better your chances of selling!

For example: "Original Monkey shirts! Handmade in Oakland, California."

tags(optional)
STRING
The tags of your item. Use tags to improve the searchability and distribution of your item. You can insert multiple tags by separating them with commas. Maximum 20 tags allowed.

For example: "t-shirt,monkey,white"

quantity(optional)
NUMBER
The quantity of your item. Use -1 for unlimited and 1 or more for fixed amounts.

For example: "20"

require_shipment_address(optional)
BOOLEAN
Requires your buyers to enter a shipment address when they're buying your item. Comes in handy if you want to know where to ship your item! Default: false.

For example: "true"

shipment_countries(optional)
STRING
Define the countries or regions that you'll be able to ship your item to. Use the 2 letter country code for individual countries or the regions from the "getRegions" method to define all the countries in a region at once! You can define multiple shipment_countries by separating them with a comma.

For example: "US,FR,IT,european_union"

shipment_costs(optional)
STRING
Define the shipment costs for the countries or regions you've defined in 'shipment_countries'. Make sure you put the costs in the same order! Separate multiple costs with a comma.

For example: "2,4.50,5,6.90"

shipment_costs_per_item(optional)
BOOLEAN
Charges shipment costs per item instead per order. This means that the shipment costs will increase with every item. Default: false.

For example: "false"

geo_latitude(optional)
NUMBER
The latitude coordinate for your item. If your item doesn't have a physical location simply provide the location of any place you'd like. Range: -90 to 90.

For example: "37.80436"

geo_longitude(optional)
NUMBER
The longitude coordinate for your item. If your item doesn't have a physical location simply provide the location of any place you'd like. Range: -180 to 180.

For example: "-122.27111"

image_tokens(optional)
STRING
The image_tokens from the images you've uploaded with "uploadImage". You can define multiple image_tokens by separating them with a comma.

For example: "pIgxQUZlQHyuWrgrvRZeOdi1D6lIWyx4,nXdZjB6lFklmGWLzby7B7ynAX5fqPIWs"

file_token(optional)
STRING
The file_token from the file you've uploaded with "uploadFile". It's only possible to define a single file.

For example: "6Fe4BByWLCxGrsOtTVBIPE5RgC57EjGU"

widget_url(optional)
STRING
The widget url of a Embed.ly supported service. See http://embed.ly/providers for the entire list.

For example: "http://soundcloud.com/titanoz/lily-bizarre-fallen-titanoz-remix"

charity_id(optional)
STRING
Enter a charity_id if you want to donate a certain percentage (see charity_percentage) to a charity. You can find all supported charities with the "getCharities" method.

For example: "a7Fdfx"

charity_percentage(optional)
NUMBER
The percentage of your sales price you want to donate to a charity. Range: 0.01 (1%) to 1 (100%).

For example: "0.2"

language(optional)
STRING
The language in which this item is placed. This property is used to improve the searchability of your item. You can find all supported languages with the "getLanguages" method.

For example: "en-us"

country(optional)
STRING
The primary country in which this item is placed. This property is used to improve the searchability of your item. You can find all supported countries with the "getCountries" method.

For example: "US"

Results

success
BOOLEAN
Returns true or false.

For example: "true"

Example

JSON 
{"success":true}

JSON (Learn how)

POST https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/item/{item_id}/update

access_token=A-VALUE
title=A-VALUE
currency=A-VALUE
price=A-VALUE
description=A-VALUE
tags=A-VALUE
quantity=A-VALUE
require_shipment_address=A-VALUE
shipment_countries=A-VALUE
shipment_costs=A-VALUE
shipment_costs_per_item=A-VALUE
geo_latitude=A-VALUE
geo_longitude=A-VALUE
image_tokens=A-VALUE
file_token=A-VALUE
widget_url=A-VALUE
charity_id=A-VALUE
charity_percentage=A-VALUE
language=A-VALUE
country=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

updateMyProfile (POST)

This method has no description

Parameters

access_token
NONE

This parameter field has no description

name
NONE

This parameter field has no description

profile_description(optional)
NONE

This parameter field has no description

Results

avatar (optional)
NONE

This result field has no description

bio (optional)
NONE

This result field has no description

facebook (optional)
NONE

This result field has no description

language (optional)
NONE

This result field has no description

linkedin (optional)
NONE

This result field has no description

name (optional)
NONE

This result field has no description

rating (optional)
NONE

This result field has no description

time_created (optional)
NONE

This result field has no description

twitter (optional)
NONE

This result field has no description

url (optional)
NONE

This result field has no description

user_id (optional)
NONE

This result field has no description

Example

JSON 
{"avatar":"sample value","bio":"sample value","facebook":"sample value","language":"sample value","linkedin":"sample value","name":"sample value","rating":"sample value","time_created":"sample value","twitter":"sample value","url":"sample value","user_id":"sample value"}

JSON (Learn how)

POST https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/me

access_token=A-VALUE
name=A-VALUE
profile_description=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

uploadFile (POST) 

Upload a file. Maximum size: 1GB.

Parameters

access_token
STRING
This method requires a valid access_token. You can obtain your personal access token by logging in here: https://tinypay.me/oauth/your_token or request permission from another user with "getOAuthPermission" (requires 'create_item' permission).

For example: "ilkOk4bHj8huCtJnAUx0wY5KHQNnK99uJ8ygN3P1fk... (84 chars)"

file
STRING
Base64 encoded string of the file

For example: "/9j/4AAQSkZJRgABAQEASABIAAD/2wBDABALCwwMDBENDREYEA4QGBwVEREVHCEZGRkZ..."

name
STRING
The name of the file

For example: "handson-nodejs.zip"

Results

name (optional)
STRING
The file name of the uploaded file.

For example: "The_Wooden_Ipad_Stand_Story.pdf.zip"

size (optional)
STRING
The file size of the uploaded file.

For example: "1.46 MB"

thumbnail (optional)
STRING
Image only: thumbnail of the uploaded image.

For example: "http://img.tinypay.me/DDo7VJBn4CcuwiScDb0..."

token (optional)
STRING
This token is the identifier of the uploaded file and should be provided by the "createItem" or "updateItem" methods.

For example: "OUSffKKAEKt1TVM3Uetpu7SdMuOWoKxt"

Example

JSON 
{"name":"The_Wooden_Ipad_Stand_Story.pdf.zip","size":"1.46 MB","thumbnail":"http://img.tinypay.me/DDo7VJBn4CcuwiScDb0...","token":"OUSffKKAEKt1TVM3Uetpu7SdMuOWoKxt"}

JSON (Learn how)

POST https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/file

access_token=A-VALUE
file=A-VALUE
name=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

uploadImage (POST) 

Upload an image. Maximum size: 5 MB.

Parameters

access_token
STRING
This method requires a valid access_token. You can obtain your personal access token by logging in here: https://tinypay.me/oauth/your_token or request permission from another user with "getOAuthPermission" (requires 'create_item' permission).

For example: "ilkOk4bHj8huCtJnAUx0wY5KHQNnK99uJ8ygN3P1fk... (84 chars)"

file
STRING
Base64 encoded string of the image.

For example: "/9j/4AAQSkZJRgABAQEASABIAAD/2wBDABALCwwMDBENDREYEA4QGBwVEREVHCEZGRk..."

name
STRING
Name of the file.

For example: "yellow_canary.jpg"

Results

name (optional)
STRING
The file name of the uploaded image.

For example: "screen_shot_1.jpg"

size (optional)
STRING
The file size of the uploaded image.

For example: "2.34 MB"

thumbnail (optional)
STRING
The URL of the thumbnail of the uploaded image. You can use this to preview an image after upload. Maximum dimensions: 92 x 69 px.

For example: "http://img.tinypay.me/DDo7VJBn4CcuwiScDb0..."

token (optional)
STRING
This token is the identifier of the uploaded image and should be provided by the "createItem" or "updateItem" methods.

For example: "35r8RZvJhurZxoA6RbCWA79iHZxmGRVV"

Example

JSON 
{"name":"screen_shot_1.jpg","size":"2.34 MB","thumbnail":"http://img.tinypay.me/DDo7VJBn4CcuwiScDb0...","token":"35r8RZvJhurZxoA6RbCWA79iHZxmGRVV"}

JSON (Learn how)

POST https://SwnOmB09bsY1a1TfWwxqlAeRo.proxy.mashape.com/mashape/image

access_token=A-VALUE
file=A-VALUE
name=A-VALUE
  • The required parameters have a yellow background, while the optional are gray
  • Authentication: Request a valid _token before making the API call. Learn how.

PHP (Learn how)

This client library will be auto-generated on the fly

Ruby (Learn how)

This client library will be auto-generated on the fly

Python (Learn how)

This client library will be auto-generated on the fly

Java (Learn how)

This client library will be auto-generated on the fly

Objective C (Learn how)

This client library will be auto-generated on the fly