OMS DOCUMENTATIONRESOURCE CENTER

These guides provide examples for many tasks that a developer will need to be familiar with during implementation.

KIBO OMS DEVELOPMENT

Documentation

PerfectSync: Setup and Testing

PerfectSync must be configured with API endpoints and mappings to allow the front-end provider to integrate with Kibo OMS and the Customer Care interface. This guide provides an explanation of the PerfectSync integration, lists the data that must be provided to Kibo, and provides examples for the tests that will be performed.

A few abbreviations are used throughout this guide:

  • CCUI / Customer Care UI = Customer Care User Interface
  • MFG = Manufacturer (e.g. MFGID = Manufacturer ID)

Understanding PerfectSync

The PerfectSync system includes a transformation router and cartridges that pass data through mapped API endpoints between OMS and the front end.

This system is integrated with the Customer Care UI so that the APIs are called when elements of the interface are used. For instance, searching for products in the interface triggers the Query Product API in PerfectSync. When making an order through the CCUI, a series of API calls are triggered at different points in the process to collect customer, shipping, tax, and promotional data. This information is then passed to the front-end through the Create Order API.

The below diagram illustrates the relationships between systems linked with PerfectSync.

The below diagram is the flow chart for the steps taken to create an order in the CCUI using PerfectSync. It shows the points in the process at which the different PerfectSync APIs are called.

API Endpoints

In order to use PerfectSync through the Customer Care UI, the relevant API calls need to be set up first. URL mappings must be added to the PerfectSync cartridge so that the CCUI knows where to make the calls to. These API requests are routed from the CCUI to the front end, where the hostname is replaced by a configuration and forwarded to the transformation service.

Thus, working endpoints for the following API connections need to be provided to Kibo. Note that some APIs in the below list end with {*}. This denotes that the call expects some sort of value after the standard API address. This may be a search term or an identifier used to specify the data instance being retrieved or modified. See the appropriate API guide for more information on the requests and responses made from these APIs.

  • GET/api/snap/v1/customer/{*}
  • POST/api/snap/v1/order/{*}
  • GET/api/snap/v1/ping/
  • GET/api/snap/v1/product/
  • GET/api/snap/v1/product/{*}
  • POST/api/snap/v1/promotion/calculate/
  • POST/api/snap/v1/shipping/calculate/
  • POST/api/snap/v1/shipping/countries/
  • POST/api/snap/v1/shipping/methods/
  • POST/api/snap/v1/shipping/regions/
  • POST/api/snap/v1/tax/calculate/

Testing

Testing of the PerfectSync and Customer Care UI functionality is performed as a joint effort between Kibo Professional Services and the client. The following cases give examples of the steps that are expected to be taken when verifying the integration.

Order and Customer Creation

This tests the New Order flow in the CCUI and verifies that a user is able to create an order for a new customer with the PerfectSync integration active.

StepExpected Result
1Log in to CCUI as Admin.User logs in successfully.
2Click on New Order in the top nav.New Order page loads successfully.
3Select a MFG/Catalog set up for PerfectSync (note: this will be selected automatically for the client user).MFG found and selected successfully. A product search box should appear.
4Enter a product name in the search field that appears (i.e. “Standard” or “Test”) and click Search icon.List of products are found and displayed.
5Click on a product and select Add to Cart.Product is added to the cart displayed on the right nav.
6Click Checkout.Find Customer page is loaded.
7Enter valid values for First Name, Last Name, Email Address, and Phone Number. The email address should be something unique so a new customer will be created. Click Continue.Create Customer page opens.
8Click Create Customer.Create Order – Delivery page opens.
9Click Continue.Create Order – Shipping and Billing page opens.
10Enter valid values for all fields displayed and check the “Use the same address for shipping and billing”. Click Continue.Create Order – Delivery method page opens.
11Click Continue.Create Order – Payment page opens.
12Enter a test CC number in the Card Number field (i.e. 4111111111111111), an expiration date past today’s date, and a test CVV number (i.e. 111). Click Place Order.Order is created and orderID is displayed.

Order Details Customer Information

This verifies that the user is able to view customer information in order details from the PerfectSync cartridge.

StepExpected Result
1Log in to CCUI as Admin.User logs in successfully.
2Select the MFG/Catalog that was set up for PerfectSync integration (note: this will be selected automatically for the client user).MFG/Catalog found and selected successfully.
3Search for the prerequisite order.Order found and order details page loads successfully.
4Check the Customer Card and the Shipping Cards to verify all the information is displayed correctly for the PerfectSync customer.All customer information is displayed correctly on the order details page.

Customer Record Information

This verifies that the information on the customer record page for a customer is correctly displayed from the PerfectSync cartridge.

StepExpected Result
1Log in to CCUI as Admin.User logs in successfully.
2Search for the prerequisite customer using the search fields in the center of the dashboard page. Select the correct customer on the results page if more than one result is returned.Customer is found and the customer record page is opened.
3Verify the Firstname, Lastname, and email fields are all displayed correctly.Customer information is displayed correctly.
4Verify the Shipping Address information is displayed correctly.Shipping information is displayed correctly.
5Verify the Custom Data values are displaying correctly.All customer custom data values are displaying correctly.
6Verify Billing and Payment section displays all information correctly.Billing and Payment sections display all information correctly.
7Verify the order history table displays all order information for each column.Order history table displays order information for each column.

Add Item on Order Details

This verifies that the user is able to add an item to an existing order for a PerfectSync customer through the order details page.

StepExpected Result
1Log in to CCUI as Admin.User logs in successfully.
2Select the MFG/Catalog that was set up for PerfectSync integration (note: this will be selected automatically for the client user).MFG/Catalog found and selected successfully.
3Search for prerequisite orderID in the quick search on the top right.Order found and order details page loads successfully.
4Click on Add Item on the left nav.A Find Product search box appears.
5Enter a product name in the search field (i.e. “Standard” or “Test”) and click Search icon.List of products are found and displayed.
6Click on one of the products and click Add to Order.A new item should be added to the order and will be displayed in the Items section under Shipments.