Shop

The Shop resource displays information about how the shop is configured.

By making GET requests to the subresources you can retrieve the different values a subresource can have.
E.g. A GET request to https://wsmedia.tlsecure.com/api/json/00000/shop/deliveryType will show which Delivery types are allowed by the shop

1 Shop
- 1.1 Languages
- 1.2 Countries
- 1.3 Address types
- 1.4 Interests
- 1.5 Delivery types
- 1.6 Payment methods
- 1.7 Giftwrap
- 1.8 Shop
- 1.9 Collection Points
- 1.10 Collection Point

Languages

Displays the languages supported by the shop. A customer may be stored with his language, but that's not required.

Example

https://wsmedia.tlsecure.com/api/json/00000/shop/language

Request

HTTP Verb : GET
URL : http://{WS_URL}/{returnType}/{domainCode}/shop/language

Parameters	Location	Type	Required	Default	Accepted

Parameters	Location	Type	Required	Default	Accepted

Response

Success

{
	"response": {
	"success": true
	"code": 0
	"message": "languages retrieved"
	"object": {
		"languages": {
			"language": [2]
				0:  {
					"id": 1
					"code": "FR"
				}
				1:  {
					"id": 2
					"code": "NL"
				}
			}
		}
	}
}

Codelist

Code	Success	Message

Code	Success	Message
0	v	languages retrieved
1		domaincode malformed
2		connexion error
99		uncatched exception

Countries

Displays the countries supported by the shop. Countries are used for addresses and delivery.

Example

https://wsmedia.tlsecure.com/api/json/00000/shop/country

Request

HTTP Verb : GET
URL : http://{WS_URL}/{returnType}/{domainCode}/shop/country

Parameters	Location	Type	Required	Default	Accepted

Parameters	Location	Type	Required	Default	Accepted
-

Response

Success

{
	"response": {
		"success": true
		"code": 0
		"message": "countries retrieved"
		"object": {
			"countries": {
				"country": [3]
					0:  {
						"id": 1
						"code": "BE"
					}
					1:  {
						"id": 2
						"code": "NL"
					}
					2:  {
						"id": 3
						"code": "LU"
					}
			}
		}
	}
}

Codelist

Code	Success	Message

Code	Success	Message
0	v	countries retrieved
1		domaincode malformed
2		connexion error
99		uncatched exception

Address types

Displays the Address types supported by the shop.
Address types sort the customer's addresses in two groups : delivery and invoice. At least one of each address type usually has to be configured.

More information about Address types >>

Example

https://wsmedia.tlsecure.com/api/json/00000/shop/addressType

Request

HTTP Verb : GET
URL : http://{WS_URL}/{returnType}/{domainCode}/shop/addressType

Parameters	Location	Type	Required	Default	Accepted

Parameters	Location	Type	Required	Default	Accepted
-

Response

Success

{
	"response": {
		"success": true
		"code": 0
		"message": "address types retrieved"
		"object": {
			"adressTypes": {
				"addressType": [2]
					0:  {
						"id": 1
						"type": "Delivery"
					}
					1:  {
						"id": 2
						"type": "Invoice"
					}
			}
		}
	}
}

Codelist

Code	Success	Message

Code	Success	Message
0	v	address types retrieved
1		domaincode malformed
2		connexion error
99		uncatched exception

Interests

Displays a list of interests defined by the shop.

Example

https://wsmedia.tlsecure.com/api/json/00000/shop/interest

Request

HTTP Verb : GET
URL : http://{WS_URL}/{returnType}/{domainCode}/shop/interest

Parameters	Location	Type	Required	Default	Accepted

Parameters	Location	Type	Required	Default	Accepted
-

Response

Success

Error

Codelist

Code	Success	Message

Code	Success	Message
0	v	interests retrieved
1		domaincode malformed
2		connexion error
10		no interests defined
99		uncatched exception

Delivery types

Displays the delivery types allowed by the shop.

Reserved delivery types

The reserved parameter specifies whether or not the delivery type is a “system” one, with some particular functions.
Reserved delivery types are :

Delivery in shop (id: 1) - Can be chosen by the customer. He has to pick up his order in the shop that he will have to select. No shipping costs are applied.
Only eBooks (id: 2) - Can not be chosen by the customer. This delivery type will be used automatically if all products in the cart are eBooks. No shipping costs are applied.
FullFilment (id: 3) - Can not be chosen by the customer. It will be set during the ordering process, according to the shop's preferences concerning delivery and if the customer wants to be delivered at home.
At home (id: 4) - Can be chosen by the customer. This is the default “at home” delivery ; some other transporters/delivery companies could also be chosen (but these aren't reserved delivery types). However, if you give the choice to choose specific transporters/delivery companies, this default type shouldn't be given anymore.
Choice by library (id: 5) - Can not be chosen by the customer. With that parameter, every orders will get directly into Medialog. That choice is done with shop preferencies.

Example

https://wsmedia.tlsecure.com/api/json/00000/shop/deliveryType

Request

HTTP Verb : GET
URL : http://{WS_URL}/{returnType}/{domainCode}/shop/deliveryType

Parameters	Location	Type	Required	Default	Accepted

Parameters	Location	Type	Required	Default	Accepted
-

Response

Success

Error

Codelist

Code	Success	Message

Code	Success	Message
0	v	delivery types retrieved
1		domaincode malformed
2		connexion error
10		no delivery types defined
99		uncatched exception

Payment methods

Displays the payment methods allowed by the shop.

Reserved payment methods

The reserved parameter specifies whether or not the payment method is a “system” one, with some particular functions.
Reserved payment methods are :

Payment at shop (id: 1) - Can be chosen by the customer. The customer will pay at shop. Evidently, this payment method is only available in case of a delivery in shop.
Confirmed by shop (id: 2) - If you use this payment method, it's up to you to deal with the payment process, and then, to push the result to our services by the order status update.

Example

https://wsmedia.tlsecure.com/api/json/00000/shop/paymentMethod

Request

HTTP Verb : GET
URL : http://{WS_URL}/{returnType}/{domainCode}/shop/paymentMethod

Parameters	Location	Type	Required	Default	Accepted

Parameters	Location	Type	Required	Default	Accepted
-

Response

Success

Error

Codelist

Code	Success	Message

Code	Success	Message
0	v	payment methods retrieved
1		domaincode malformed
2		connexion error
10		no payment methods defined
99		uncatched exception

Giftwrap

Displays the giftwrap list.

The list contains all the types of Giftwraps the shop has defined (e.g.: New Year / Sinterklaas / Pasen / Birthday…).

Example

https://wsmedia.tlsecure.com/api/json/00000/shop/giftwrap

Request

HTTP Verb : GET
URL : http://{WS_URL}/{returnType}/{domainCode}/shop/giftwrap

Parameters	Location	Type	Required	Default	Accepted

Parameters	Location	Type	Required	Default	Accepted

Response

Success

Error

Codelist

Code	Success	Message

Code	Success	Message
0	v	giftwraps retrieved
1		domaincode malformed
2		connexion error
10		no giftwraps defined
99		uncatched exception

Shop

Displays the shop list.

The list contains all shopof the domainCode

Example

https://wsmedia.tlsecure.com/api/json/00000/shop/shop

Request

HTTP Verb : GET
URL : http://{WS_URL}/{returnType}/{domainCode}/shop/shop

Parameters	Location	Type	Required	Default	Accepted

Parameters	Location	Type	Required	Default	Accepted

Response

Success

Error

Codelist

Code	Success	Message

Code	Success	Message
0	v	shop retrieved
1		domaincode malformed
2		connexion error
10		no shop defined
99		uncatched exception

Collection Points

Displays the collection point list.

The list contains all collection point of the domainCode.

Example

https://wsmedia.tlsecure.com/api/json/00000/shop/collectionPoint

Request

HTTP Verb : GET
URL : http://{WS_URL}/{returnType}/{domainCode}/shop/collectionPoint

Parameters	Location	Type	Required	Default	Accepted

Parameters	Location	Type	Required	Default	Accepted
token	Header	String(26)	v

Response

Success

Codelist

Code	Success	Message

Code	Success	Message
0	v	get collection points
10		collection point not exist
99		uncatched exception

Collection Point

Displays the collection point.

Example

https://wsmedia.tlsecure.com/api/json/00000/shop/collectionPoint/0

Request

HTTP Verb : GET
URL : http://{WS_URL}/{returnType}/{domainCode}/shop/collectionPoint/{id}

Parameters	Location	Type	Required	Default	Accepted

Parameters	Location	Type	Required	Default	Accepted
token	Header	String(26)	v
id	Path	Integer

Response

Success

Codelist

Code	Success	Message

Code	Success	Message
0	v	get collection point
10		collection point not exist
99		uncatched exception

WS Shop

Shop

Languages

Example

Request

Response

Success

Codelist

Countries

Example

Request

Response

Success

Codelist

Address types

Example

Request

Response

Success

Codelist

Interests

Example

Request

Response

Success

Error

Codelist

Delivery types

Reserved delivery types

Example

Request

Response

Success

Error

Codelist

Payment methods

Reserved payment methods

Example

Request

Response

Success

Error

Codelist

Giftwrap

Example

Request

Response

Success

Error

Codelist

Shop

Example

Request

Response

Success

Error

Codelist

Collection Points

Example

Request

Response

Success

Codelist

Collection Point

Example

Request

Response

Success

Codelist

Related content