ViURShopClient - Documentation

Constructor

new ViURShopClient()

Source:

ViURShopClient.js, line 9

Classes

ViURShopClient

Members

host_url

URL to the shop-backend (ViUR server)

Source:

ViURShopClient.js, line 14

shop_api_url

URL to shop API module with the default renderer

Source:

ViURShopClient.js, line 34

shop_json_url

URL to shop root module with the json renderer

Source:

ViURShopClient.js, line 29

shop_module

Name of the shop root module

Source:

ViURShopClient.js, line 19

shop_url

URL to shop root module with the default renderer

Source:

ViURShopClient.js, line 24

Methods

basket_list() → {Promise.<Response>}

List the children of the basket (the cart stored in the session)

Source:

ViURShopClient.js, line 239

Returns:

Type:: Promise.<Response>

basket_view() → {Promise.<Response>}

View the basket (the cart stored in the session) itself

Source:

ViURShopClient.js, line 249

Returns:

Type:: Promise.<Response>

cart_add(parent_cart_key, cart_type, nameopt, customer_commentopt, shipping_address_keyopt, shipping_keyopt, discount_keyopt) → {Promise.<Response>}

Add a new cart node

Source:

ViURShopClient.js, line 157

Parameters:

Name	Type	Attributes	Description
`parent_cart_key`	`string`		Key of the parent cart
`cart_type`	`CartType`		Type of the cart node, see `CartType`
`name`	`string`	<optional>	Optional. Name of the cart node
`customer_comment`	`string`	<optional>	Optional. Comment to this node, by customer.
`shipping_address_key`	`string`	<optional>	Optional. Key of the address
`shipping_key`	`string`	<optional>	Optional. Key of the shipping
`discount_key`	`string`	<optional>	Optional. Key of the discount

Returns:

Type:: Promise.<Response>

cart_list(cart_key) → {Promise.<Response>}

List root nodes or children of a cart If a cart key is provided, the direct children (nodes and leafs) will be returned. Otherwise (without a key), the root nodes will be returned.

Source:

ViURShopClient.js, line 137

Parameters:

Name	Type	Description
`cart_key`	`string`	list direct children (nodes and leafs) of this parent node

Returns:

Type:: Promise.<Response>

cart_remove(cart_key) → {Promise.<Response>}

Remove a cart node. Removes itself and all children

Source:

ViURShopClient.js, line 224

Parameters:

Name	Type	Description
`cart_key`	`string`	Key of the cart node to be removed

Returns:

Type:: Promise.<Response>

cart_update(cart_key, cart_type, nameopt, customer_commentopt, shipping_address_keyopt, shipping_keyopt, discount_keyopt) → {Promise.<Response>}

Update an existing cart node

Source:

ViURShopClient.js, line 193

Parameters:

Name	Type	Attributes	Description
`cart_key`	`string`		Key of the cart node to be updated
`cart_type`	`CartType`		Type of the cart node, see `CartType`
`name`	`string`	<optional>	Optional. Name of the cart node
`customer_comment`	`string`	<optional>	Optional. Comment to this node, by customer.
`shipping_address_key`	`string`	<optional>	Optional. Key of the address
`shipping_key`	`string`	<optional>	Optional. Key of the shipping
`discount_key`	`string`	<optional>	Optional. Key of the discount

Returns:

Type:: Promise.<Response>

discount_add(code, discount_key) → {Response.<Response>}

Add a Discount to the current Cart.

Source:

ViURShopClient.js, line 481

Parameters:

Name	Type	Description
`code`	`string`	Human readable Discount Code
`discount_key`	`string`	Database Key from a Discount.

Returns:

Type:: Response.<Response>

discount_remove(discount_key) → {Promise.<Response>}

Removes a Discount by the Database Key

Source:

ViURShopClient.js, line 500

Parameters:

Name	Type	Description
`discount_key`	`string`	Database Key from a Discount.

Returns:

Type:: Promise.<Response>

order_checkout_order(key) → {Promise.<Response>}

The final order now step

Source:

ViURShopClient.js, line 453

Parameters:

Name	Type	Description
`key`	`String`	The key of the order

Returns:

Type:: Promise.<Response>

order_checkout_start(key) → {Promise.<Response>}

Start the checkout process

Source:

ViURShopClient.js, line 438

Parameters:

Name	Type	Description
`key`	`String`	The key of the order

Returns:

Type:: Promise.<Response>

order_list(param) → {Promise.<Response>}

List the orders of the current user

Source:

ViURShopClient.js, line 409

Parameters:

Name	Type	Description
`param`	`object`	Any key-value pairs for filtering or ordering

Returns:

Type:: Promise.<Response>

order_view(order_key) → {Promise.<Response>}

View an order

Source:

ViURShopClient.js, line 423

Parameters:

Name	Type	Description
`order_key`	`String`	Key of the order to view. Use "SESSION" as key to view the order of the current session

Returns:

Type:: Promise.<Response>

payment_providers_list(onlyAvailableopt) → {Promise.<Response>}

Get a list of payment providers. This API method returns a JSON response containing a object of payment providers. The keys in the response represent provider identifiers, and the values are objects describing the details of each provider.

Source:

ViURShopClient.js, line 341

Parameters:

Name	Type	Attributes	Default	Description
`onlyAvailable`	`boolean`	<optional>	true	If true, only payment providers that are currently available will be included in the response. If false, all providers will be listed regardless of availability.

Returns:

Type:: Promise.<Response>

shipping_list(cart_key) → {Promise.<Response>}

Lists available shipping options for a (sub)cart

Source:

ViURShopClient.js, line 518

Parameters:

Name	Type	Description
`cart_key`	`string`	Key of the parent cart

Returns:

Type:: Promise.<Response>

List of ShippingsSkels