Mock sample for your project: Compliance API

Note: This is a (Limited Release) API available only to select developers approved by business units. This API allows third-party developers to search for and retrieve details about eBay deals and events, as well as the items associated with those deals and events.

The Catalog API allows users to search for and locate an eBay catalog product that is a direct match for the product that they wish to sell. Listing against an eBay catalog product helps insure that all listings (based off of that catalog product) have complete and accurate information. In addition to helping to create high-quality listings, another benefit to the seller of using catalog information to create listings is that much of the details of the listing will be prefilled, including the listing title, the listing description, the item specifics, and a stock image for the product (if available). Sellers will not have to enter item specifics themselves, and the overall listing process is a lot faster and easier.

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.

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.

The Account API gives sellers the ability to configure their eBay seller accounts, including the seller's policies (the Fulfillment Policy, Payment Policy, and Return Policy), opt in and out of eBay seller programs, configure sales tax tables, and get account information. For details on the availability of the methods in this API, see Account API requirements and restrictions.

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.

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.

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.

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.

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

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.

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

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.

A product library is a representation of all the items that can be
displayed, put in a shopping cart and sold to a customer. Items may be
either producs or discounts.
A product is a synthetic construct, wrapping one or more variants (which is
the actual item being sold) Variants expresses different variations of
properties such as for example price, size or color. A discount will reduce
the total amount charged in a shopping cart. It can be used per item line,
or on the whole cart. It may reduce the affected amount by a percentage, or
by a fixed amount.
Together, the above types of entities makes up a complete library. The
library can be fetched as a whole through the library endpoint, where each
consecutive change applied to the library is available. Once the full
library is retrieved, only later events needs to be fetched to keep the
client up to date with the server
All path patterns "/organizations/{organizationUuid}/" can be replaced
with "/organizations/self/" for convenience as all endpoints are for
authorized users.

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

The Account API gives sellers the ability to configure their eBay seller accounts, including the seller's policies (the Fulfillment Policy, Payment Policy, and Return Policy), opt in and out of eBay seller programs, configure sales tax tables, and get account information. For details on the availability of the methods in this API, see Account API requirements and restrictions.

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.

The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.

カラーミーショップアプリストア API
アプリストアにて公開するアプリに対して、一般公開しているカラーミーショップAPIに加えて、カラーミーショップアプリストアAPI（以下、アプリストアAPIといいます）を利用することが出来ます。アプリストアAPIでは以下のことが行えます。
課金データ(アプリ内課金、従量課金)の作成
インラインスクリプトタグの取得・作成・更新・削除
スクリプトタグの取得・作成・更新・削除
利用手順
アプリストアAPIを利用するには、OAuth認証が必要です。OAuth認証の基本的な流れについてはカラーミーショップAPIドキュメントを参照してください。
アプリストアAPIの利用のために、以下のscopeが追加で指定可能になります。カラーミーショップAPIドキュメントに掲載されているscopeと合わせてご利用ください。
|スコープ|機能|
|---|---|
|writeapplicationcharge|課金データの作成|
|readshopscript_tags|ショップページのスクリプトタグを参照|
|writeshopscript_tags|ショップページへスクリプトタグを追加・更新|
|readinlinescript_tags|インラインスクリプトタグを参照|
|writeinlinescript_tags|インラインスクリプトタグを追加・更新|
|readscripttags|スクリプトタグを参照(deprecated)|
|writescripttags|スクリプトタグを追加・更新(deprecated)|
(例) カラーミーショップアカウントの認証ページを表示

This is the documentation for PIM Micro services. In order to use this tool you need to have Basic Auth credentials and a client id. If you dont have one, please make sure to request one by sending an email to the PIM MS team: [email protected]

This API is used to retrieve seller payouts and monetary transaction details related to those payouts.

Please make sure you use the correct version of the APIs for your use case. To find out the appropriate version, go to the API Docs drop down on the menu.

The Browse API has the following resources: itemsummary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values. (Experimental) searchbyimage: Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters. item: Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part. Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs. (Experimental) shoppingcart: Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart. Note: This resource is not available in the eBay API Explorer. The itemsummary, searchbyimage, and item resource calls require an Application access token. The shoppingcart resource calls require a User access token.

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.