Web API - Integrations and Data Exchange with Other Programs.

Enabling WebAPI

Select Configuration

Only regular administrators can be used to connect to WebAPI.

1. Check Enable WebApi,
2. Set Session duration (time given in seconds),
3. Choose whether to automatically delete expired sessions from the login list,
4. Choose whether to enforce the use of API via SSL,
5. Press the Save button.

WebAPI Logins

Select WebApi Logins

WebAPI Functions in SOTESHOP

List of WebApi functions depending on the module.

Producers (stProducer)

• AddProducer - adds a new producer,
• CountProducer - returns the number of producers,
• DeleteProducer - deletes a producer,
• GetProducer - retrieves producer data,
• GetProducerList - returns a list of producers,
• UpdateProducer - updates producer data,

Producer Address

Categories (stCategory)

• AddCategory - adds a new category,
• CountCategory - returns the number of categories,
• DeleteCategory - deletes a category,
• GetCategory - retrieves category data,
• GetCategoryList - returns a list of categories,
• UpdateCategory - updates category data,

Category Address

Products (stProduct)

• AddAvailability - adds availability for a product,
• AddProduct - adds a new product,
• AddProductImage - adds a new image to a product,
• AddProductPrice - adds a product price in a selected currency,
• AddTax - adds a new VAT rate,
• AssignProductToCategory - assigns a product to a category,
• CountAvailability - counts availabilities,
• CountProduct - counts products,
• CountProductImage - counts product images,
• CountProductOptionsList - counts the number of product options,
• CountProductPrice - returns the number of prices in currencies,
• CountTax - counts VAT rates,
• DeleteAvailability - deletes availability for the product,
• DeleteProduct - deletes the product,
• DeleteProductImage - deletes the product image,
• DeleteProductPrice - deletes the price in the currency,
• DeleteTax - deletes the VAT rate,
• GetAvailability - retrieves availability for the product,
• GetAvailabilityList - retrieves the availability list,
• GetProduct - retrieves product data,
• GetProductByCode - retrieves product data,
• GetProductImage - returns the product image,
• GetProductImageList - returns the list of product images,
• GetProductList - returns the list of products,
• GetProductOptionsList - returns the list of product options,
• GetProductPrice - retrieves the product price in the selected currency,
• GetProductPriceList - retrieves the product prices in the currency.,
• GetTax - returns the VAT rate,
• GetTaxList - returns a list of VAT rates,
• GetRecommendedList - returns a list of recommended products,
• GetAccessoriesList - returns a list of accessories,
• RemoveProductFromCategory - removes the assignment of a product to a category,
• UpdateAvailability - updates the availability for a product,
• UpdateProduct - updates the data of a product,
• UpdateProductByCode - updates the data of a product,
• UpdateProductOption - updates the options of a product,
• UpdateProductPrice - updates the price of a product in the selected currency.
• UpdateTax - updates the VAT rate,
• UpdateRecommendedList - updates the list of recommended products,
• UpdateAccessoriesList - updates the list of accessories,

Product Address

Users (stUser)

• AddUser - adds a new user,
• AddUserProfile - adds a new customer profile,
• CountUser - returns the number of users,
• CountUserProfile - returns the number of customer profiles,
• DeleteUser - deletes a user,
• DeleteUserProfile - deletes a customer profile,
• GetUser - retrieves user data,
• GetUserList - returns a list of users,
• GetUserProfile - retrieves a customer profile,
• GetUserProfileList - returns a list of customer profiles,
• UpdateUser - updates user data,
• UpdateUserProfile - updates a customer profile,

User Address

Logins (stWebApiBackend)

• ClearCache - clearing the cache,
• doLogin - logging into the system,
• GetVersion - returns the version of the API module,
• Noop - extends the session and returns the time of its completion,
• Test - testing communication,

Login Address

Orders (stOrder)

• AddOrder - adds a new order,
• GetOrder - returns detailed data about the order,
• GetOrderCount - returns the number of orders in the store,
• GetOrderList - returns a list of orders,
• GetOrderByNumber - returns an order based on its number,
• GetOrderPayment - retrieves payment information for a given order,
• GetOrderProductList - returns a list of products in the order,
• GetOrderStatusList - returns a list of available order statuses,
• OrderProductSetType - data type for the GetOrderProductList method,
• SetOrderPaymentStatus - sets the payment status for an order,
• UpdateOrder - updating an order,
• UpdateOrderStatus - updating the order status in the order,
• UpdateOrderDeliveryNumber - updating the shipment number in the order,

Order address

Gift cards

• AddGiftCard - adds a new gift card
• CountGiftCard - provides the total number of gift cards,
• DeleteGiftCard - deletes a gift card,
• GetGiftCard - retrieves information about a gift card,
• GetGiftCardList - retrieves a list of gift cards,
• UpdateGiftCard - updates information about a gift card.

Gift Card Address

Discount Codes

• AddDiscountCouponCode - adds a new discount code,
• CountDiscountCouponCode - provides the total number of discount codes,
• DeleteDiscountCouponCode - deletes a discount code,
• GetDiscountCouponCode - retrieves information about a discount code,
• GetDiscountCouponCodeList - retrieves a list of discount codes,
• UpdateDiscountCouponCode - updates information about a discount code.

Discount Code Address

Payment Types (stPaymentType)

• GetPaymentType - returns the Payment Type with the given identifier,
• GetPaymentTypeList - Returns a list of payment types,
• CountPaymentType - returns the number of payment types in the shop.,

Payment Type Address

Currencies (stCurrency)

• GetCurrency - retrieves a currency,
• GetCurrencyByShortcut - retrieves a currency by ISO 4217 code,
• GetCurrencyList - retrieves a list of currencies,

Currency Address