Welcome to ePages Client’s documentation!¶

Contents:

ePages Client¶

Python 3 client for ePages REST API.

Free software: MIT license
Documentation: https://epages-client.readthedocs.io.

Features¶

TODO

Credits¶

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation¶

Stable release¶

To install ePages Client, run this command in your terminal:

$ pip install epages_client

This is the preferred method to install ePages Client, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources¶

The sources for ePages Client can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/vilkasgroup/epages_client

Or download the tarball:

$ curl  -OL https://github.com/vilkasgroup/epages_client/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage¶

Basic usage¶

To use ePages Client in a project:

from epages_client.client import RestClient

# Set the api url and token for your shop
api_url = "https://yourshop.vilkasstore.com/rs/shops/yourshop/"
api_token = "shop_token_goes_here"

# Get the instance of the client
client = RestClient(api_url, api_token)

# Example method: get shop info
shop_info = client.get_shop_info()

The dictionary parameter¶

Each method accepts a single dictionary parameter called params. This parameter is not mandatory for all methods.

# params can have five different keys
params = {
    "data": "",
    "param1": "",
    "param2": "",
    "query": {},
    "object": "",
}

data
- The content here is usually a dictionary, but can have a binary file, too.
param1
- The first parameter to add to the api url.
param2
- The second parameter to add to the api url.
query
- A dictionary for query parameters, for example including hidden items in results.
object
- As the name implies, this gets an object as a value. Objects are located in the dataobjects directory.

Examples¶

# Example 1

# Set category id and product id
params["data"] = {
        'categoryId': "5A41E34F-BAC7-8396-336A-0A2810152BBC",
        'productId': "5A497829-7619-ACCC-E487-0A281012346F"
}

# Connect category and product
response = client.connect_category_and_product(params)

# Example 2

# Set product id
# The api url will be:
# https://yourshop.vilkasstore.com/rs/shops/yourshop/products/5A497829-7619-ACCC-E487-0A281012346F
params["param1"] = "5A497829-7619-ACCC-E487-0A281012346F"

# Get product data
product = client.get_product(params)

# Example 3

# Set product id and image name
# The api url will be:
# https://yourshop.vilkasstore.com/rs/shops/yourshop/products/5A497829-7619-ACCC-E487-0A281012346F/slideshow/test.jpg
params["param1"] = "5A497829-7619-ACCC-E487-0A281012346F"
params["param2"] = "test.jpg"

# Delete image from product
response = client.delete_product_image(params)

# Example 4

# Find products where name contains the word 'laptop'
# Limit search results to have 50 items
params["query"] = {
    "query": "laptop",
    "limit": 50
}

# Search for the products
results = self.client.search_products(self.params)

# Example 5

# Create a customer
customer = CustomerCreate()
customer.billingAddress.firstName = "John"
customer.billingAddress.lastName = "Doe"
customer.billingAddress.emailAddress = "john.doe@mail.com"

# Add customer to params
params["object"] = customer

# Create a customer
response = client.add_customer(params)

Currency and locale¶

There are two ways to set currency and locale.

Note: If currency and locale are set using both setters and params[“query”], values of params[“query”] are used.

# Currency and locale are set using client setters
client.currency = "GBP"
client.locale = "en_US"

# Currency and locale are set using params["query"]
params["query"] = {
    "currency": = "GBP",
    "locale": = "en_US"
}

Methods¶

Here’s a list of available methods to use with ePages Client. Each method accepts a single dict parameter called params. The more detailed description of the param is found in the usage document. Method descriptions have a link to the ePages API, too.

Welcome to ePages Client’s documentation!¶

ePages Client¶

Features¶

Credits¶

Installation¶

Stable release¶

From sources¶

Usage¶

Basic usage¶

The dictionary parameter¶

Examples¶

Currency and locale¶

Methods¶

Customers¶

get_customers¶

get_customer¶

add_customer¶

update_customer¶

Legal information¶

get_legal_information¶

get_contact_information¶

get_privacy_policy¶

get_terms_and_conditions¶

get_rights_of_withdrawal¶

get_shipping_information¶

update_contact_information¶

update_privacy_policy¶

update_terms_and_conditions¶

update_rights_of_withdrawal¶

update_shipping_information¶

Newsletters¶

get_newsletter_campaigns¶

get_newsletter_campaign_subscribers¶

Orders and carts¶

get_orders¶

get_order¶

get_order_documents¶

get_sales¶

get_cart¶

add_cart¶

add_coupon¶

delete_coupon¶

add_cart_line_item¶

update_cart_line_item¶

delete_cart_line_item¶

add_order¶

update_order¶

update_billing_address¶

delete_billing_address¶

update_shipping_address¶

delete_shipping_address¶

Products¶

get_shop_info¶

get_categories¶

get_category¶

get_currencies¶

get_locales¶

get_products¶

get_product¶

get_product_variations¶

get_product_images¶

get_product_image_names¶

get_product_custom_attributes¶

get_product_lowest_price¶

search_products¶

get_shipping_methods¶

get_shipping_method¶

get_tax_classes¶

get_tax_class¶

get_tax_model¶

add_category¶

update_category¶

delete_category¶

get_subcategory_sequence¶

update_subcategory_sequence¶

add_product¶

update_product¶

delete_product¶

upload_product_image¶

delete_product_image¶