Mock sample for your project: Pims API

Integrate with "Pims API" from pims.io in no time with Mockoon's ready to use mock sample

Pims

pims.io

Version: 1.0


Use this API in your project

Integrate third-party APIs faster by using "Pims API" ready-to-use mock sample. Mocking this API will allow you to start working in no time. No more accounts to create, API keys to provision, accesses to configure, unplanned downtime, just work.
Improve your integration tests by mocking third-party APIs and cover more edge cases: slow response time, random failures, etc.

Description

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.

Other APIs in the same category

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.

Billbee API

Documentation of the Billbee REST API to connect a Billbee account to external aplications.
Endpoint
The Billbee API endpoint base url is https://app.billbee.io/api/v1
Activation
You have to enable the API in the settings of your Billbee account. In addition you need a Billbee API Key identifying the application you develop. To get an API key, send a mail to [email protected] and send us a short note about what you are building.
Authorization & security
Because you can access private data with the Billbee API, every request has to be sent over https and must
Contain a valid API Key identifying the application/developer. It has to be sent as the HTTP header X-Billbee-Api-Key
Contain a valid user login with billbee username and api password in form of a basic auth HTTP header
Throttling
Each endpoint has a throttle of max 2 requests per second per combination of API Key and Billbee user.
When you exceed these 2 calls, the API will return a HTTP 429 status code

Identity API

apiz.ebay.com
Note: This is a (Limited Release) API available only to select developers approved by business units. Retrieves the authenticated user's account profile information. It can be used to let users log into your app or site using eBay, which frees you from needing to store and protect user's PII (Personal Identifiable Information) data.

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 |

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.

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.

AGCO API

agco-ats.com

BeezUP Merchant API

The REST API of BeezUP system
Overview
The REST APIs provide programmatic access to read and write BeezUP data.
Basically, with this API you will be able to do everything like you were with your browser on https://go.beezup.com !
The main features are:
Register and manage your account
Create and manage and share your stores with your friends/co-workers.
Import your product catalog and schedule the auto importation
Search the channels your want to use
Configure your channels for your catalogs to export your product information:
cost and general settings
category and columns mappings
your will be able to create and manage your custom column
put in place exlusion filters based on simple conditions on your product data
override product values
get product vision for a channel catalog scope
Analyze and optimize your performance of your catalogs on all yours channels with different type of reportings by day, channel, category and by product.
Automatize your optimisation by using rules!
And of course... Manage your orders harvested from all your marketplaces:
Synchronize your orders in an uniformized way
Get the available actions and update the order status
...and more!
Authentication credentials
The public API with the base path /v2/public have been put in place to give you an entry point to our system for the user registration, login and lost password. The public API does not require any credentials.
We give you the some public list of values and public channels for our public commercial web site www.beezup.com.
The user API with the base path /v2/user requires a token which is available on this page:
https://go.beezup.com/Account/MyAccount
Things to keep in mind
API Rate Limits
The BeezUP REST API is limited to 100 calls/minute.
Media type
The default media type for requests and responses is application/json. Where noted, some operations support other content types. If no additional content type is mentioned for a specific operation, then the media type is application/json.
Required content type
The required and default encoding for the request and responses is UTF8.
Required date time format
All our date time are formatted in ISO 8601 format: 2014-06-24T16:25:00Z.
Base URL
The Base URL of the BeezUP API Order Management REST API conforms to the following template.
https://api.beezup.com
All URLs returned by the BeezUP API are relative to this base URL, and all requests to the REST API must use this base URL template.
You can test our API on https://api-docs.beezup.com/swagger-ui\\
You can contact us on gitter, #BeezUP/API

ecwid

cloud-elements.com

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.

Account API

ebay.com
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.

agentOS API V3, Maintenance Call Group

letmc.com