Articles in this section

API

Laura Molano
  • Updated
Follow

Topics Covered:

Introduction

Onboarding

Support

________________________________________________________________________________________________________________

Introduction

The content provided in this section is intended for users who wish to create a partnership with Olivela using an API integration.

 

Contacts

Olivela - Marthaluz Quiteno - marthaluz@olivela.com

Logicbroker - support@logicbroker.com 

* Please be sure to communicate through the same email thread we reach out to you on. If you need to create a new thread, include all the contacts above *

 

Things to Note

  • Olivela does not support invoices, returns or backorders.
  • You will have access to both stage and production web portals but be sure to do all testing in the stage web portal. We will notify you when it is time to use the production web portal to upload live inventory and process live orders.

 

Helpful Links

Stage Portal - https://stageportal.logicbroker.com/ - where testing takes place

Production Portal - https://portal.logicbroker.com/ - where live orders are processed

Olivela Knowledge Base - https://olivela.logicbroker.com/hc/en-us - where you can look up any testing or production-related questions

Learn Logicbroker - https://learn.logicbroker.com/ - Logicbroker's Learning Management System that will walk you through the portal and provide a supplier overview

* Note that you will need to log in to access all of these links with the exception of the Knowledge Base so make sure you complete Step 1 below *

 

Integration Method Overview

API integrations are often times lengthier than portal integrations as suppliers will need to work with our API to send documents. 

  • Order Processing: Orders are sent out to suppliers through the API, suppliers send back acknowledgments (acceptances or cancellations) and shipments to Logicbroker.
  • Inventory: Suppliers send inventory into Logicbroker. 
    • once with all fields (Supplier SKU, Quantity, Cost, Supplier Description, Size, Color, Style (if applicable))
    • daily with only required fields (Supplier SKU, Quantity, Cost)
    • inventory is sent and Olivela updates their site accordingly.
  • Packing Slips: Suppliers can either download packing slips directly from Logicbroker – this can also be done in bulk or they can map their own packing slip using Olivela specifications and have Olivela review before going live.

API Information

API: Documentation

 

________________________________________________________________________________________________________________

Onboarding

This section will walk you through all the steps you need to complete for a successful go-live.

Step 1: Create a Logicbroker Account

You should have already received an invitation from Logicbroker via email. Subject Line: "Welcome to Logicbroker!". This invitation will allow you to create a login and password to the Logicbroker platform. Don’t see the email? Check your junk mail folder & add do-not-reply@logicbroker.com to your contacts list.

Action: 

  1. Accept the invitation within 7 days and create your Logicbroker account. The link expires after 7 days so if you miss the window, let us know and we can send out a new invitation. 
  2. Once you have created an account, you send out invitations to anyone else on your team. To see how, see User Management

Step 2: Review the LMS (Learning Management System)

Learn Logicbroker is our Learning Management System which offers learning materials to help you become more comfortable with your dropship experience. Here, we offer an extensive library of videos, photos, and written information to help acclimate you to Logicbroker and help you succeed with your integration with Olivela. Only registered users can access Learn Logicbroker so make sure you complete Step 1 before attempting to log in. 

Action: Logicbroker will assign you the Portal Supplier Onboarding Path which includes the following modules:

  • Welcome to Learn Logicbroker
  • Getting Started with Logicbroker: The Portal
  • Supplier Overview

If you lose the email or want to have another member of your team walk through the path, you can access and share the link here: Portal Supplier Onboarding Path

To access Learn Logicbroker, go here: Learn Logicbroker

* Note that this content is general information for all PORTAL suppliers - some information is not Olivela specific such as information on returns and invoices and some information is not relevant to API suppliers such as manually creating documents and uploading Excel/CSV inventory. Once you walk through the path, you will continue on to Olivela/API specific tasks noted below *

 

 

Step 3: Set Up Your API Connection

Once you have walked through the LMS, you can now begin Olivela-specific tasks. Here, you will work in the stage portal. See Logicbroker's API documentation and set up your connection. If you will be mapping your own packing slip, make sure you do this early on to avoid any delays later in the process.

Action: 

  1. Review the documentation and reference files below to set up your API connection:
  2. Go to Logicbroker's API Tool in stage portal (Settings > API Authentication)

* If there is an API key already there, confirm with your team before regenerating, as that could break an existing connection

 

Step 4: Send Test Inventory

Your next step is to transmit inventory information to Logicbroker through the API. 

Action: 

  1. Using the API documentation above, send inventory into the stage portal. 
    • All fields below are required for your FIRST transmission, and any Live transmission where you are adding to your assortment:
      • Supplier SKU
      • Quantity
      • Cost
      • Supplier Description
      • Size * if applicable
      • Color * if applicable
      • Style * if applicable
  1.  
  2. Verify your inventory was successfully transmitted to Logicbroker. To do this:
    • go to stage portal > Products > Inventory Feeds > select Olivela as your Partner > check the Events tab:
      •  the Events tab should say "Inventory Imported"mceclip0.png

Running into issues with this step? see Onboarding Help

 

Step 5: Complete Test Cases

After you have successfully sent your inventory to Logicbroker, you will move onto testing where you will complete 3 test cases. 

Action: 

  1. In stage portal, go to Logicbroker's Testing Tool: Testing > Olivela: View > click on Create a New Test Order for each of the three test cases

  2. Confirm these orders are transmitted to your system through the API (this may take a few minutes)

  3. Process the 3 test cases through your system:
    • Test Case 1: Fulfill (Single Line)
      • Send an acknowledgment fully accepting the order
      • Send a shipment fully shipping the order *include a Carrier and a Tracking Number. The tracking number can be any alphanumeric string

    • Test Case 2: Fulfill (Multi Line)
      • Send an acknowledgment fully accepting the order
      • Send a shipment fully shipping the order *include a Carrier and a Tracking Number. The tracking number can be any alphanumeric string

    • Test Case 3: Cancel 
      • Send an acknowledgment to fully cancel the order. *If you plan on canceling orders manually through the web portal in production, you may process this order directly in the portal instead of sending an 855 (See Creating an Acknowledgement). Be sure to change the Quantity Cancelled for each line item so that it matches the Quantity Ordered, and enter in the Change Reason: Out of Stock for each under Acknowledgement Items.

  4. Confirm testing is complete by going to Logicbroker's Testing Tool stage portal > Testing > the bar should be fully greenmceclip0.png

Running into issues with this step? see Onboarding Help

 

Step 5b: Request Packing Slip Approval

* Note that Olivela prefers you use Logicbroker-generated packing slips

If you choose to map your own packing slip using Olivela's packing slip specifications, you will need to have a test packing slip approved by the Olivela team.

Actions:

  1. Create 2 test packing slip PDFs per Olivela’s specifications. 
    • 1st PDF: Standard packing slip (no gift message)
    • 2nd PDF: Packing slip with gift message
  2. Send test packing slips via email using the active onboarding thread to request approval from the Olivela team.

 

Step 6: Request Inventory Approval

Once you’ve completed the 3 test cases, you will need an updated inventory to be approved in the stage portal.

Action: 

  1. Send or upload your updated inventory into the stage portal.  If there has been no change in quantity or product assortment since your initial inventory was sent, you can skip this step.
  2. Request approval of your new inventory upload in the stage portal.  If you skipped Step 1, please request re-approval of your initial inventory.

If any corrections need to be made, Olivela will communicate them in this step.

 

Step 7: Switch to Production + Send Live Inventory

When Olivela approves your updated stage inventory, you are nearly ready to go live!

Action:

  1. Generate production API Keys (refer back to API Documentation above)
  2. Send your newly-approved inventory into the production / live portal the same way you did in stage.

 

Ready to go live!

Olivela will reach out with next steps to launch via email.

From this point on, you will use the production portal only. You will not need to send any information to the stage portal anymore, except for special cases.

________________________________________________________________________________________________________________

Support

See the Onboarding Help article

If you have any other questions throughout the onboarding or production phase, review:

Both these resources are great for training new members of your team! If you need additional support, reach out to support@logicbroker.com, marthaluz@olivela.com, and dropship@olivela.com. 

 

Related articles

Comments

0 comments

Please sign in to leave a comment.