Open API (Admin)

Getting Started With the API

WebinOne uses APIs for just about all of its CMS functionality (adding, editing, finding and deleting content) and these APIs are progressively being opened up for public access for use with connecting external systems to your WebinOne instances.

CRM Contacts API

Create, Retrieve, Update and Delete CRM Contacts via the public API endpoint using "where" filtering as well as retrieve a contact's Bookings, Cases and Orders. The contact's Secure Zone details can also be retrieved and password reset via this API.

Advanced CRM Groups API

Create, Retrieve, Update and Delete Advanced CRM Groups via the public API endpoint, with "where" filtering and field type lookups. Available apply-to types can also be retrieved via this API.

Customer Types API

Retrieve Customer Types via the public API endpoint.

CRM Cases API

Create, Retrieve, Update and Delete CRM Cases via the public API endpoint using "where" filtering.

CRM Bookings API

Create, Retrieve, Update and Delete CRM Bookings via the public API endpoint using "where" filtering.

CRM Orders API

Retrieve and Update Order Items via the public API endpoint using "where" filtering.

CRM Order Lines API

Create, Retrieve, Update and Delete CRM Order Lines within an Order via the public API endpoint.

CRM Order Assets API

Create CRM Order Assets, such as Discount Codes, Gift Vouchers, Shipping Options and Tax Codes via the public API endpoint.

CRM Order Payments API

Create, Retrieve, Update and Delete CRM Order Payments within an Order via the public API endpoint using "where" filtering.

CRM Order Statuses API

Create, Retrieve, Update and Delete CRM Order Statuses via the public API endpoint using "where" filtering.

CRM Order Trash API

Retrieve CRM Orders in trash via the public API endpoint using "where" filtering.

Member Areas API

Create, Retrieve, Update and Delete Member Areas via the public API endpoint using "where" filtering, as well as retrieve a Member Area's Content, Files and Members. Member Area content and members can also be added and removed, and file content secured and unsecured via this API.

Print (Order) API

Retrieve the print version of an Order asset via the public API endpoint by type.

Modules API

Create, Retrieve, Update and Delete Modules via the public API endpoint using "where" filtering.

Module Properties API

Create, Retrieve, Update and Delete Module Properties via the public API endpoint as well as setting their sort order and Retrieving and Updating Property settings.

Module Layouts API

Create, Retrieve, Update or Delete Module Layouts via the public API endpoint using "where" filtering.

Module Items API

Create, Retrieve, Update and Delete Module Items via the public API endpoint using "where" filtering as well as Retrieve and Update Module Item's SEO data.

Module Items Attributes API

Create, Retrieve, Update and Delete Module Items Attributes via the public API endpoint via "where" filtering as well as update the attribute sort order.

Module Items Attribute Options API

Create, Update and Delete Module Items Attribute Options via the public API endpoint.

Module Item Draft API

Update and Delete Module Item Drafts via the public API endpoint including the publishing of drafts.

Module Item Prices API

Create, Retrieve, Update and Delete a Module Item's Prices via the public API endpoint.

Module Item Inventory API

Retrieve, Update and Delete Module Item Inventory via the public API endpoint as well as generating inventory variations.

Module Item Related Items API

Retrieve and Update a Module Item's Related Items via the public API endpoint.

Module Item Grouped Items API

Create, Retrieve, Update and Delete a Module Item's Grouped Items via the public API endpoint.

Module Item Parent Items API

Retrieve and Update a Module Item's Parent Items via the public API endpoint.

eCommerce Discount Codes API

Create, Retrieve, Update and Delete Ecommerce Discount Codes via the public API endpoint using "where" filtering.

eCommerce Gift Vouchers API

Create, Retrieve, Update and Delete eCommerce Gift Vouchers via the public API endpoint using "where" filtering.

eCommerce Shipping Options API

Create, Retrieve, Update and Delete eCommerce Shipping Options via the public API endpoint as well as return external shipping providers and settings.

eCommerce Taxes API

Create, Retrieve, Update and Delete eCommerce Taxes via the public API endpoint using "where" filtering.

eCommerce Settings API

Retrieve and Update eCommerce Settings via the public API endpoint, as well as retrieve a list of available Countries and Tax and Shipping settings.

Payment Gateways API

Retrieve, Update and Delete Payment Gateway Settings via the public API endpoint, as well as retrieve available Payment Provider Settings and manage Payment Flow Settings.

Menus API

Create, Retrieve, Update and Delete Menus via the public API endpoint using "where" filtering, as well as manage a Menu's Items and Layout Groups.

Site Globals API

Create, Retrieve, Update and Delete Site Global Groups and their Properties via the public API endpoint using "where" filtering.

Forms API

Create, Retrieve, Update and Delete Forms via the public API endpoint using "where" filtering, as well as retrieve a Form's Settings and Template. The Form's Field Groups, Field Types, Recurring Types and Form Types can also be retrieved, and a Form Template can be generated via this API.

Workflows API

Create, Retrieve, Update and Delete Workflows via the public API endpoint using "where" filtering.

Emails API

Create, Retrieve, Update and Delete System Emails (such as Workflow Notification, Follow Up Notification, Abandoned Cart Notification, and Recurring Reminders) via the public API endpoint using "where" filtering, as well as retrieve available Email Custom Groups.

Email Templates API

Create, Retrieve, Update and Delete Email Templates via the public API endpoint using "where" filtering.

System Emails API

Retrieve and Update System Emails via the public API endpoint using "where" filtering, and retrieve available template variables. A System Email can also be restored to its default content via this API.

System Pages API

Retrieve and Update System Pages via the public API endpoint using "where" filtering, as well as retrieve and update a System Page's SEO settings. The default page content can also be retrieved via this API.

Email Notification Sender API

Trigger various system Email Notifications via the public API endpoint.

Content Templates API

Create, Retrieve, Update and Delete Content Templates via the public API endpoint using "where" filtering.

Categories API

Create, Retrieve, Update and Delete Categories via the public API endpoint using "where" filtering.

File System API

Create, Retrieve, Update and Delete File System items (Folders and Files) via the public API endpoint include their Secure Zone assignments or to assign Secure Zones.

Snippets API

Create, Retrieve, Update and Delete Snippets via the public API endpoint using "where" filtering.

URL Redirects API

Create, Retrieve, Update and Delete URL Redirects via the public API endpoint using "where" filtering.

URL Rewrites API

Create, Retrieve, Update and Delete URL Rewrites via the public API endpoint using "where" filtering.

Admin Menu API

Retrieve and Update the Admin Menu via the public API endpoint.

Admin Users API

Create, Retrieve, Update and Delete Admin Users via the public API endpoint using "where" filtering. Admin User invitations can also be re-sent via this API.

Admin User Roles API

Create, Retrieve, Update and Delete Admin Roles via the public API endpoint using "where" filtering. The default restrictions schema for Admin Roles can also be retrieved via this API.