Corporate Workspace

Introduction

Getting Started

Partner API

Products

Company Data

Deployment

Default

Ooodles Platform API

Ooodles Partner API Documentation

Production

Sandbox

<p class="slate-p " >The Ooodles Platform API section enables companies in the human resource domain to effortlessly integrate their applications with the platform. Users can leverage this API to streamline the process of ordering IT equipment for employees, whether through leasing or direct purchase. This section serves as a vital gateway for companies looking to enhance their HR capabilities and improve overall efficiency.</p><p class="slate-p " ></p><p class="slate-p " ></p>

The Ooodles Platform API section enables companies in the human resource domain to effortlessly integrate their applications with the platform. Users can leverage this API to streamline the process of ordering IT equipment for employees, whether through leasing or direct purchase. This section serves as a vital gateway for companies looking to enhance their HR capabilities and improve overall efficiency.

<p class="slate-p " >This section will serve as the guide before making your first API request.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h3 class="slate-h3 " >Login to your Ooodles account</h3><p class="slate-p " >Head straight at <a href="https://www.ooodles.com/login" target="">https://www.ooodles.com/login</a> to login your account and go to your <a href="https://www.ooodles.com/dashboard" target="">customer dashboard</a>.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Go to <code class="slate-code">API</code> Tab</h3><p class="slate-p " >This is the page within your dashboard where api access token generation takes place.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">NOTE</strong>: If you can&apos;t see API tab in the dashboard, please contact <a href="https://mailto:tech@ooodles.com" target="_self">tech@ooodles.com</a> to request API Platform access.</p></div></div></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Generate your API Access Token</h3><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">NOTE</strong>: Creation of tokens is per-company basis which means that the billing will go straight to your company representative and the list of tokens may be populated
by someone, a person from different team or department, within your company who also has access to the API platform.</p></div></div></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >4</h6><h3 class="slate-h3 " >Making your request</h3><p class="slate-p " >Every API request requires an <code class="slate-code">Authorization</code> header, where the value is <code class="slate-code">Bearer &lt;your_generated_api_access_token&gt;</code>.</p></div></div></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

This section will serve as the guide before making your first API request.

Every API request requires an Authorization header, as "Bearer -token-"

Authorization

<p class="slate-p " ></p><p class="slate-p " >Initiates deployment of a single product kit to a specified employee. Creates an order, assigns the kit to the employee, and schedules delivery to their designated shipping address. Includes tracking information and delivery confirmations.</p><p class="slate-p " >This operation will charge the associated billing method and cannot be easily reversed.</p><p class="slate-p " ></p>

Initiates deployment of a single product kit to a specified employee. Creates an order, assigns the kit to the employee, and schedules delivery to their designated shipping address. Includes tracking information and delivery confirmations.

This operation will charge the associated billing method and cannot be easily reversed.

Product Kit Deployment

productKitId

employeeWithDeliveryDateInput

message

orderId

deploymentId

trackingInfo

estimatedDelivery

	
Product kit deployment initiated successfully

error

details

timestamp

path

	
Bad request - validation errors or invalid input

	
Unauthorized - missing or invalid authentication

<p class="slate-p " ></p><p class="slate-p " >Deploys a complete product bundle to an employee. Handles the deployment of multiple related products as a single unit, ensuring coordinated delivery and setup. Ideal for onboarding new employees or role changes.</p><p class="slate-p " >All items in the bundle will be shipped together when possible.</p><p class="slate-p " ></p>

Deploys a complete product bundle to an employee. Handles the deployment of multiple related products as a single unit, ensuring coordinated delivery and setup. Ideal for onboarding new employees or role changes.

All items in the bundle will be shipped together when possible.

Product Bundle Deployment

productBundleId

	
Product bundle deployment initiated successfully

<p class="slate-p " >Performs bulk deployment operations across multiple employees simultaneously. Supports deploying different product combinations to different employees in a single API call. Ideal for large-scale rollouts, team equipment updates, or company-wide initiatives.</p><p class="slate-p " >This operation processes multiple deployments and may take longer to complete than individual deployments.</p><p class="slate-p " ></p>

Performs bulk deployment operations across multiple employees simultaneously. Supports deploying different product combinations to different employees in a single API call. Ideal for large-scale rollouts, team equipment updates, or company-wide initiatives.

This operation processes multiple deployments and may take longer to complete than individual deployments.

Mass Deployment

employeeDeploymentDataInput

batchId

totalDeployments

successful

failed

deployments

<p class="slate-p " ></p><p class="slate-p " >Places a bulk preorder for products before they become available for immediate deployment. Useful for planning ahead for new employee onboarding, seasonal needs, or upcoming product launches. Supports both product kits and bundles with flexible quantity management.</p><p class="slate-p " >Preorders will be automatically processed when products become available.</p><p class="slate-p " ></p>

Places a bulk preorder for products before they become available for immediate deployment. Useful for planning ahead for new employee onboarding, seasonal needs, or upcoming product launches. Supports both product kits and bundles with flexible quantity management.

Sections