Mock sample for your project: Recommendation API

Integrate with "Recommendation API" from ebay.com in no time with Mockoon's ready to use mock sample

Recommendation API

ebay.com

Version: 1.1.0


Use this API in your project

Speed up your application development by using "Recommendation API" ready-to-use mock sample. Mocking this API will help you accelerate your development lifecycles and allow you to stop relying on an external API to get the job done. No more API keys to provision, accesses to configure or unplanned downtime, just work.
Enhance your development infrastructure by mocking third party APIs during integrating testing.

Description

The Recommendation API returns information that sellers can use to optimize the configuration of their listings on eBay. Currently, the API contains a single method, findListingRecommendations. This method provides information that sellers can use to configure Promoted Listings ad campaigns to maximize the visibility of their items in the eBay marketplace.

Other APIs by ebay.com

Buy Marketing API

ebay.com
The Marketing API retrieves eBay products based on a metric, such as Best Selling, as well as products that were also bought and also viewed.

Taxonomy API

ebay.com
Use the Taxonomy API to discover the most appropriate eBay categories under which sellers can offer inventory items for sale, and the most likely categories under which buyers can browse or search for items to purchase. In addition, the Taxonomy API provides metadata about the required and recommended category aspects to include in listings, and also has two operations to retrieve parts compatibility information.

Translation API

ebay.com
This API allows 3rd party developers to translate item title, description, search query.

Seller Service Metrics API

ebay.com
The Analytics API provides data and information about a seller and their eBay business. The resources and methods in this API let sellers review information on their listing performance, metrics on their customer service performance, and details on their eBay seller performance rating. The three resources in the Analytics API provide the following data and information: Customer Service Metric – Returns data on a seller's customer service performance as compared to other seller's in the same peer group. Traffic Report – Returns data that shows how buyers are engaging with a seller's listings. Seller Standards Profile – Returns data pertaining to a seller's performance rating. Sellers can use the data and information returned by the various Analytics API methods to determine where they can make improvements to increase sales and how they might improve their seller status as viewed by eBay buyers. For details on using this API, see Analyzing seller performance.

Fulfillment API

ebay.com
Use the Fulfillment API to complete the process of packaging, addressing, handling, and shipping each order on behalf of the seller, in accordance with the payment method and timing specified at checkout.

Negotiation API

ebay.com
The Negotiations API gives sellers the ability to proactively send discount offers to buyers who have shown an "interest" in their listings. By sending buyers discount offers on listings where they have shown an interest, sellers can increase the velocity of their sales. There are various ways for a buyer to show interest in a listing. For example, if a buyer adds the listing to their Watch list, or if they add the listing to their shopping cart and later abandon the cart, they are deemed to have shown an interest in the listing. In the offers that sellers send, they can discount their listings by either a percentage off the listing price, or they can set a new discounted price that is lower than the original listing price. For details about how seller offers work, see Sending offers to buyers.

Marketing API

ebay.com
The Marketing API offers two platforms that sellers can use to promote and advertise their products: Promoted Listings is an eBay ad service that lets sellers set up ad campaigns for the products they want to promote. eBay displays the ads in search results and in other marketing modules as SPONSORED listings. If an item in a Promoted Listings campaign sells, the seller is assessed a Promoted Listings fee, which is a seller-specified percentage applied to the sales price. For complete details, see Promoted Listings. Promotions Manager gives sellers a way to offer discounts on specific items as a way to attract buyers to their inventory. Sellers can set up discounts (such as "20% off" and other types of offers) on specific items or on an entire customer order. To further attract buyers, eBay prominently displays promotion teasers throughout buyer flows. For complete details, see Promotions Manager. Marketing reports, on both the Promoted Listings and Promotions Manager platforms, give sellers information that shows the effectiveness of their marketing strategies. The data gives sellers the ability to review and fine tune their marketing efforts. Important! Sellers must have an active eBay Store subscription, and they must accept the Terms and Conditions before they can make requests to these APIs in the Production environment. There are also site-specific listings requirements and restrictions associated with these marketing tools, as listed in the "requirements and restrictions" sections for Promoted Listings and Promotions Manager. The table below lists all the Marketing API calls grouped by resource.

Listing API

ebay.com
Note: This is a (Limited Release) API available only to select developers approved by business units. Enables a seller adding an ad or item on a Partner's site to automatically create an eBay listing draft using the item details from the Partner's site.

Seller Service Metrics API

ebay.com
The Analytics API provides data and information about a seller and their eBay business. The resources and methods in this API let sellers review information on their listing performance, metrics on their customer service performance, and details on their eBay seller performance rating. The three resources in the Analytics API provide the following data and information: Customer Service Metric – Returns data on a seller's customer service performance as compared to other seller's in the same peer group. Traffic Report – Returns data that shows how buyers are engaging with a seller's listings. Seller Standards Profile – Returns data pertaining to a seller's performance rating. Sellers can use the data and information returned by the various Analytics API methods to determine where they can make improvements to increase sales and how they might improve their seller status as viewed by eBay buyers. For details on using this API, see Analyzing seller performance.

Progress to Rate Limit API

ebay.com
The Analytics API retrieves call-limit data and the quotas that are set for the RESTful APIs and their associated resources. Responses from calls made to getRateLimits and getUerRateLimits include a list of the applicable resources and the "call limit", or quota, that is set for each resource. In addition to quota information, the response also includes the number of remaining calls available before the limit is reached, the time remaining before the quota resets, and the length of the "time window" to which the quota applies. The getRateLimits and getUserRateLimits methods retrieve call-limit information for either an application or user, respectively, and each method must be called with an appropriate OAuth token. That is, getRateLimites requires an access token generated with a client credentials grant and getUserRateLimites requires requires an access token generated with an authorization code grant. For more information, see OAuth tokens. Users can analyze the response data to see whether or not a limit might be reached, and from that determine if any action needs to be taken (such as programmatically throttling their request rate). For more on call limits, see Compatible Application Check.

Item Feed Service

ebay.com
Note: This is a (Limited Release) API available only to select developers approved by business units. The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file of the items that have changed within an hour for a specific category, date and marketplace. In addition to the API, there is an open source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file.

Charity API

ebay.com
The Charity API allows third-party developers to search for and access details on supported charitable organizations.

Other APIs in the same category

Price Management

walmart.com
The price is a fundamental building block for your listing on Walmart.com. You can use the price management APIs to set up and manage the price for a given item

Velo Payments APIs

velopayments.com
Terms and Definitions
Throughout this document and the Velo platform the following terms are used:
Payor. An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout.
Payee. The recipient of funds paid out by a payor.
Payment. A single transfer of funds from a payor to a payee.
Payout. A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee.
Sandbox. An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking.
Overview
The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution:
Authenticate with the Velo platform
Maintain a collection of payees
Query the payor’s current balance of funds within the platform and perform additional funding
Issue payments to payees
Query the platform for a history of those payments
This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference.
API Considerations
The Velo Payments API is REST based and uses the JSON format for requests and responses.
Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details.
Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters).
Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print.
Authenticating with the Velo Platform
Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner.
You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following:
create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529
base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==
create an HTTP Authorization header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==
perform the Velo authentication REST call using the HTTP header created above e.g. via curl:
If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a 401 HTTP status response.

LetMC Api V3, reporting

letmc.com

FraudLabs Pro Fraud Detection

fraudlabspro.com
Online payment fraud detection service. It helps merchants to minimize chargebacks and therefore maximize the revenue. It can be used to detect fraud for various kinds of payment method, such as credit card, paypal, cod and so on. Please visit https://www.fraudlabspro.com to learn more.

Pims

pims.io
Hereafter is the documentation of the private API of Pims: Pointages Intelligents pour le Monde du Spectacle. This API is designed for 3rd-party softwares, editors and partners. Its main purpose is to give access the core data of a Pims customer (i.e. events, ticket counts and promotions).
Authentication
The API uses basic access authentication, meaning you will need a username and password to get authorized.
As each customer in Pims has its own domain (e.g. caramba.pims.io, gdp.pims.io...), each credentials will be valid for one domain/customer only. If you need dedicated credentials for one domain, please contact us. (In any case, we will need an explicit agreement from the customer before we create these credentials.)
To make your life easy, you can try all endpoints with the public credentials below, pointing to our demo domain:
Base path: https://demo.pims.io/api
Username: demo
Password: q83792db2GCvgYVdKpU3yG3R
Response format
The API returns JSON and matches the HAL specification. The Content-Type of each response will be application/hal+json, unless an error occurs.
Please note that this documentation describes all responses “as if” they were plain JSON. The specificities of HAL are ignored on purpose, in order to remain compact and avoid repetition.
So when you read in the doc:
{"id" : 123,"property1" :"Lorem ipsum","object" : {"id" : 456,"property2" : 7.89
}
}
... you'll get in the Real World®:
{"id" : 123,"property2" :"Lorem ipsum","embedded" : {"object" : {"id" : 456,"property2" : 7.89,"links" : {"self" : {"href" :"https://api.mydomain.com/other-item/456"
}
}
}
}"_links" : {"self" : {"href" :"https://api.mydomain.com/item/123"
}
}
}
Errors
Errors return JSON too and tries to match the Problem Details for HTTP APIs specification. If it does not match this spec, that's either a bug or a compatibility issue. Please contact us to solve the problem.
The Content-Type of errors will be application/problem+json. The content will match the following JSON:
Filtering and sorting
Every textual filter (e.g. /events?label=U2) and/or sort (e.g. /events?sort=label) performed with the API uses UTF8UNICODECI collation, meaning it is:
Case insensitive: “Chloé” will be considered the same as “CHLOÉ”;
Diacritic insensitive: “Chloé” will be considered the same as “Chloe”.
When performing a sort, it will always be ascending by default. To make it descending, just use a minus sign (-) in front of the parameter value (e.g. /events?sort=-label).
I18n
In responses, some labels can be translated (e.g. promotion types, event input types, etc.). These translatable labels are clearly indicated in the documentation below.
By default, they will be displayed in English, but you can change this behaviour via the Accept-Language header. E.g., use fr as a value for French.
PHP SDK
We provide a simple yet convenient SDK for the PHP language, see the Github page of the project.
And now?
Generaly, you will start by fetching one or more events. An event can be anything that occurs in one venue at one given date and time: a concert, a play, a match, a conference, etc. Additionnally, you can explore the series: a series is just a group of events (e.g. a tour or a festival).
Once you retrieved the events you were interested in, you can look for the sales ( ticket counts):
Get a quick overview with /events/:id/ticket-counts
Or get a full insight by calling these endpoints:
/events/:id/categories
/events/:id/channels
/events/:id/ticket-counts/detailed
Eventually, you may also want to fetch the promotions. A promotion can be anything meant to leverage the sales: ads, marketing campaigns, buzz or news around the event, etc. A promotion can be linked to any combination of events and/or series.

Fulfillment.com APIv2

Welcome to our current iteration of our REST API. While we encourage you to upgrade to v2.0 we will continue support for our SOAP API.
Versioning
The Fulfillment.com (FDC) REST API is version controlled and backwards compatible. We have many future APIs scheduled for publication within our v2.0 spec so please be prepared for us to add data nodes in our responses, however, we will not remove knowledge from previously published APIs.
A Current Response
Status Codes
Codes are a concatenation of State, Stage, and Detail.
^([0-9]{2})([0-9]{2})([0-9]{2})$
| Code | State | Stage | Detail |
| ---- | ------------------ | -------- | -------------- |
| 010101 | Processing Order | Recieved | Customer Order |
| 010102 | Processing Order | Recieved | Recieved |
| 010201 | Processing Order | Approved | |
| 010301 | Processing Order | Hold | Merchant Stock |
| 010302 | Processing Order | Hold | Merchant Funds |
| 010303 | Processing Order | Hold | For Merchant |
| 010304 | Processing Order | Hold | Oversized Shipment |
| 010305 | Processing Order | Hold | Invalid Parent Order |
| 010306 | Processing Order | Hold | Invalid Address |
| 010307 | Processing Order | Hold | By Admin |
| 010401 | Processing Order | Address Problem | Incomplete Address |
| 010402 | Processing Order | Address Problem | Invalid Locality |
| 010403 | Processing Order | Address Problem | Invalid Region |
| 010404 | Processing Order | Address Problem | Address Not Found |
| 010405 | Processing Order | Address Problem | Many Addresses Found |
| 010406 | Processing Order | Address Problem | Invalid Postal Code |
| 010407 | Processing Order | Address Problem | Country Not Mapped |
| 010408 | Processing Order | Address Problem | Invalid Recipient Name |
| 010409 | Processing Order | Address Problem | Bad UK Address |
| 010410 | Processing Order | Address Problem | Invalid Address Line 1 or 2 |
| 010501 | Processing Order | Sku Problem | Invalid SKU |
| 010501 | Processing Order | Sku Problem | Child Order has Invalid SKUs |
| 010601 | Processing Order | Facility Problem | Facility Not Mapped |
| 010701 | Processing Order | Ship Method Problem | Unmapped Ship Method |
| 010702 | Processing Order | Ship Method Problem | Unmapped Ship Cost |
| 010703 | Processing Order | Ship Method Problem | Missing Ship Method |
| 010704 | Processing Order | Ship Method Problem | Invalid Ship Method |
| 010705 | Processing Order | Ship Method Problem | Order Weight Outside of Ship Method Weight |
| 010801 | Processing Order | Inventory Problem | Insufficient Inventory In Facility |
| 010802 | Processing Order | Inventory Problem | Issue Encountered During Inventory Adjustment |
| 010901 | Processing Order | Released To WMS | Released |
| 020101 | Fulfillment In Progress | Postage Problem | Address Issue |
| 020102 | Fulfillment In Progress | Postage Problem | Postage OK, OMS Issue Occurred |
| 020103 | Fulfillment In Progress | Postage Problem | Postage Void Failed |
| 020201 | Fulfillment In Progress | Postage Acquired | |
| 020301 | Fulfillment In Progress | Postage Voided | Postage Void Failed Gracefully |
| 020301 | Fulfillment In Progress | Hold | Departure Hold Requested |
| 020401 | Fulfillment In Progress | 4PL Processing | |
| 020501 | Fulfillment In Progress | 4PL Problem | Order is Proccessable, Postage Issue Occurred |
| 020601 | Fulfillment In Progress | Label Printed | |
| 020701 | Fulfillment In Progress | Shipment Cubed | |
| 020801 | Fulfillment In Progress | Picking Inventory | |
| 020901 | Fulfillment In Progress | Label Print Verified | |
| 021001 | Fulfillment In Progress | Passed Final Inspection | |
| 030101 | Shipped | Fulfilled By 4PL | |
| 030102 | Shipped | Fulfilled By 4PL | Successfully Fulfilled, OMS Encountered Issue During Processing |
| 030201 | Shipped | Fulfilled By FDC | |
| 040101 | Returned | Returned | |
| 050101 | Cancelled | Cancelled | |
| 060101 | Test | Test | Test |

Recommendation API

ebay.com
The Recommendation API returns information that sellers can use to optimize the configuration of their listings on eBay. Currently, the API contains a single method, findListingRecommendations. This method provides information that sellers can use to configure Promoted Listings ad campaigns to maximize the visibility of their items in the eBay marketplace.

Logistics API

ebay.com
Note: This is a (Limited Release) API available only to select developers approved by business units. The Logistics API resources offer the following capabilities: shipping_quote – Consolidates into a list a set of live shipping rates, or quotes, from which you can select a rate to ship a package. shipment – Creates a "shipment" for the selected shipping rate. Call createShippingQuote to get a list of live shipping rates. The rates returned are all valid for a specific time window and all quoted prices are at eBay-negotiated rates. Select one of the live rates and using its associated rateId, create a "shipment" for the package by calling createFromShippingQuote. Creating a shipment completes an agreement, and the cost of the base service and any added shipping options are summed into the returned totalShippingCost value. This action also generates a shipping label that you can use to ship the package. The total cost of the shipment is incurred when the package is shipped using the supplied shipping label. Important! Sellers must set up a payment method via their eBay account before they can use the methods in this API to create a shipment and the associated shipping label.

Feed API

ebay.com
The Feed API lets sellers upload input files, download reports and files including their status, filter reports using URI parameters, and retrieve customer service metrics task details.

Marketing API

ebay.com
The Marketing API offers two platforms that sellers can use to promote and advertise their products: Promoted Listings is an eBay ad service that lets sellers set up ad campaigns for the products they want to promote. eBay displays the ads in search results and in other marketing modules as SPONSORED listings. If an item in a Promoted Listings campaign sells, the seller is assessed a Promoted Listings fee, which is a seller-specified percentage applied to the sales price. For complete details, see Promoted Listings. Promotions Manager gives sellers a way to offer discounts on specific items as a way to attract buyers to their inventory. Sellers can set up discounts (such as "20% off" and other types of offers) on specific items or on an entire customer order. To further attract buyers, eBay prominently displays promotion teasers throughout buyer flows. For complete details, see Promotions Manager. Marketing reports, on both the Promoted Listings and Promotions Manager platforms, give sellers information that shows the effectiveness of their marketing strategies. The data gives sellers the ability to review and fine tune their marketing efforts. Important! Sellers must have an active eBay Store subscription, and they must accept the Terms and Conditions before they can make requests to these APIs in the Production environment. There are also site-specific listings requirements and restrictions associated with these marketing tools, as listed in the "requirements and restrictions" sections for Promoted Listings and Promotions Manager. The table below lists all the Marketing API calls grouped by resource.

DropX

dropx.io
dropX.io API provides programmatic access to the e-commerce intelligence data.

Negotiation API

ebay.com
The Negotiations API gives sellers the ability to proactively send discount offers to buyers who have shown an "interest" in their listings. By sending buyers discount offers on listings where they have shown an interest, sellers can increase the velocity of their sales. There are various ways for a buyer to show interest in a listing. For example, if a buyer adds the listing to their Watch list, or if they add the listing to their shopping cart and later abandon the cart, they are deemed to have shown an interest in the listing. In the offers that sellers send, they can discount their listings by either a percentage off the listing price, or they can set a new discounted price that is lower than the original listing price. For details about how seller offers work, see Sending offers to buyers.