Shop administration - WebAPI

Enabling WebAPI

Select Configuration

Only ordinary administrators can be used for WebAPI functions.

1. Tick Enable WebApi,
2. Enter Session time (time is given in seconds.),
3. Select if you want to automatically remove the obsolete sessions from the logging list,
4. Select if you want to enforce use API via SSL,
5. Press Save.

WebApi loggings

Select WebApi logging list

WebAPI functions in SOTESHOP

List of WebApi functions depending on a module.

Manufacturers (stProducer)

• AddProducer - adds a new manufacturer,
• CountProducer - returns the amount of manufacturers,
• DeleteProducer - deletes a manufacturer,
• GetProducer - gets a manufacturer's data,
• GetProducerList - returns the list of manufacturers,
• UpdateProducer - updates a manufacturer's data,

Manufacturers address

http://www.shop.example.com/backend.php/producer/soap?wsdl

Categories (stCategory)

• AddCategory - adds a new category,
• CountCategory - returns the amount of categories,
• DeleteCategory - deletes a category,
• GetCategory - gets a category data,
• GetCategoryChildrens - returns the list with all availabile categories for a parent,
• GetCategoryList - returns the list of categories,
• GetProductCategoryList - returns the list with all availabile categories for a product,
• UpdateCategory - updates a category data,

Categories address

http://www.shop.example.com/backend.php/category/soap?wsdl

Products (stProduct)

• AddAvailability - adds a new availability,
• AddProduct - adds a new product,
• AddProductImage - adds product's new image,
• AddTax - adds a new tax rate,
• AssignProductToCategory - assigns a product to a category,
• CountAvailability - returns the amount of availabilities,
• CountProduct - returns the amount of products,
• CountProductImage - returns the amount of product's images,
• CountProductOptionsList - returns the amount of product's options,
• CountTax - returns the amount of tax rates,
• DeleteAvailability - deletes an availability,
• DeleteProduct - deletes a product,
• DeleteProductImage - deletes a product's image,
• DeleteTax - deletes a tax rate,
• GetAvailability - gets an availability data,
• GetAvailabilityList - gets the list of all availabilities,
• GetProduct - gets a product's data,
• GetProductByCode - gets a product's data,
• GetProductImage - gets a product's image,
• GetProductImageList - gets the list of product's images,
• GetProductList - gets the list of products,
• GetProductOptionsList - gets the list of product's options,
• GetTax - gets a tax rate,
• GetTaxList - gets the list of tax rates,
• GetRecommendedList - gets the list of recommended products,
• GetAccessoriesList - gets the list of accessories,
• RemoveProductFromCategory - removes a product from a category,
• UpdateAvailability - updates a product's availability,
• UpdateProduct - updates a product's data,
• UpdateProductByCode - updates a product's data,
• UpdateProductOption - updates a product's options,
• UpdateTax - updates a data of tax rate,
• UpdateRecommendedList - updates the list of recommended products,
• UpdateAccessoriesList - updates the list of accessories,

Products address

http://www.shop.example.com/backend.php/product/soap?wsdl

Users (stUser)

• AddUser - adds a new user,
• AddUserProfile - adds user's new profile,
• CountUser - returns the amount of users,
• CountUserProfile - returns the amount of users profiles,
• DeleteUser - deletes an user,
• DeleteUserProfile - deletes user's profile,
• GetUser - gets user's data,
• GetUserList - gets the list of users,
• GetUserProfile - gets user's profile,
• GetUserProfileList - gets the list of users profile,
• UpdateUser - updates user's data,
• UpdateUserProfile - updates user's profile,

Users address

http://www.shop.example.com/backend.php/user/soap?wsdl

Loggings (stWebApiBackend)

• ClearCache - clears cache,
• doLogin - logs to the system,
• GetVersion - gets a version of API module.,
• Noop - extends session and returns a session's end time,
• Test - tests communication,

Loggings address

http://www.shop.example.com/backend.php/webapi/soap?wsdl

Orders (stOrder)

• GetOrder - gets an order's data,
• GetOrderCount - returns the amount of orders,
• GetOrderList - gets the list of orders,
• GetOrderListByUser - gets the list of orders for an user,
• GetOrderPayment - gets a payment method for an order,
• GetOrderProductList - gets the list of products for an order,
• GetOrderStatusList - gets the list of order statuses,
• OrderProductSetType - data type for method GetOrderProductList,
• SetOrderPaymentStatus - sets a payment status for an order,
• UpdateOrder - updates an order,
• UpdateOrderStatus - updates an order status in an order,
• UpdateOrderDeliveryNumber - updates a delivery number in an order,

Orders address

http://www.shop.example.com/backend.php/order/soap?wsdl