| Table of Contents | ||||
|---|---|---|---|---|
|
A complete reference guide to the MediaServices API.
...
WS_URL is the URL to our API. Currently, https://wsmedia.tlsecure.com is the main one, and the one we 'll use in this documentation, but you could get another one.
returnType is the format in which you want to get the response of our service. Currently, the API supports responses in json or xml.
domainCode is how we indentify your shop within our API. You receive a domaincode when you start your shop with us. In this documentation, we use the domaincode 00000 one as a test webshop.
| Table of Contents | ||||
|---|---|---|---|---|
|
Supported resources
This API reference is organized by resource type. Each resource type has one or more data response-formats (JSON/XML) and one or more HTTP methods (GET, POST, PUT, DELETE).
Each resource is typically accessible by extending the main connection string (e.g. https://wsmedia.tlsecure.com/api/json/00000) with the resourcename (e.g. customer).
For example, if you’re looking for information about customers, make a GET request to https://wsmedia.tlsecure.com/api/json/0000/customer/ .
Search Engine
Search Engine - Search through a catalogue and display details of a product
Shop
Shop - Display how a webshop is configured (Language, country..)
Customers
Customer information - Display, create and edit customers
Token - Obtain and manage tokens
Authentication - Bind a token to a customer
Lost password procedure - Lets a customer reset his or her password
Orders - Show the orders list of the customer.
WishList - Display, create and edit a wishlist
Area of interest - Lets a customer display and edit his interests
eBookShelf - Show the eBooks list of the customer and allow to get the download links.
Cart
Cart - Display and confirm shopping carts
Cart lines - Add, update and delete products from a shopping cart
Cart information - Configure a shopping cart's details (adresses, payment type…)
Giftwrap - Choose a giftwrapper, if a product needs to be wrapped as a gift.
Discount - Apply a configured discount on the line.
Order
Order status update - Update the status of an order (Admin-role only)
Buckaroo - Receive information to use Buckaroo (Admin-role only, Not recommended)
MultiSafePay - Receive information to use MultiSafePay(Admin-role only)
Product
Product information - Information on a product in Medialog (stock,..)
Stock information - Information on stock by provider
Selections
Selection - Get a list of active selections
Classifications
Classification - Get a list of all classifications
Mails
Transactional mails - Manage and configure the e-mails which are sent when a user takes an action (orderconfirmation, registration…)
Carriers
SendCloud - The SendCloud API consists of several resources.
Reference
Items
These items needs a bit more explanations about them.
Cart / Order lines (products)
Lists
The lists below describe the possible, available values a certain parameter can have.
Order line statuses (in package)