RANDEMRETAIL

API Reference

Authentication

Order

Get All Orders

Get Orders Ready For Fulfillment

Get Orders Per Location

Assign Order Location

Assign Order Bin

Mark Order as Picked

Mark Order as Packed

Mark Order as Shipped

Apply Order Discount

Create Order Comments

Get Order Comments

Update Order Shipping Address

Click And Collect

Order History

Order Items

Location

Get Locations

Get a Location

Create a Location

Update a Location

Delete a Location

Location Product

Location User

Location Operating Hour

Location Holiday

Location Bin

Location Bench

User

Get Users

Get Current User Installation

Get User by UserId

Get User Location

Update User Password

Delete Users

Save User Roles

Save User Locations

Update User Roles

Delete Users Location

Roles

GroupRoles

Picker

Inventory

Get All Products

Get a Product

Get Product By Id

Search a Product

Search Inventory by Product Id

Get Inventory per Location

Get Inventory Available for Replacement

Holiday

Get Holidays

Create a Holiday

Delete a Holiday

Packages

Get Boxes

Get a Box

Search a Box

Get Boxes w/ Filter

Interstore Transfer

Get Inter Store Orders

Get Pending Inter Store

Refund

Get Order Item Refund

Get Order Refund List

Order Item Refund Approval

Shipping Refund

Refund Order Item/s

RandemRetail.Serverless.Location

OMS by RANDEMRETAIL v3 - Management APIs

Production

Sandbox

<p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">RANDEM Order Management API allows businesses to build and create their own app. The purposes of these API are mostly to be able to retrieve, create, update and delete data.</p><p class="slate-p" placeholder="Type / for widgets">The Core APIs are Orders and Locations.</p><p class="slate-p" placeholder="Type / for widgets">RANDEM OMS API V3 is using GUID for Unique Identification instead of an integer.</p><p class="slate-p" placeholder="Type / for widgets">Descriptions is also added in each section. </p><p class="slate-p" placeholder="Type / for widgets">The data from our sample response is from our demo store.</p><p class="slate-p" placeholder="Type / for widgets"></p>

RANDEM Order Management API allows businesses to build and create their own app. The purposes of these API are mostly to be able to retrieve, create, update and delete data.

RANDEM OMS API V3 is using GUID for Unique Identification instead of an integer.

Descriptions is also added in each section. 

The data from our sample response is from our demo store.

<p class="slate-p" placeholder="Type / for widgets">A token is needed to access the Management API. Most of the Transactional API is here, that is why more secured authentication is required.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

A token is needed to access the Management API. Most of the Transactional API is here, that is why more secured authentication is required.

username

password

grant_type

domain

token_type

access_token

expires_in

error

error_description

<p class="slate-p" placeholder="Type / for widgets">OMS V3 works around orders. The beginning of transaction in RANDEM OMS is when an order went through the app.</p><p class="slate-p" placeholder="Type / for widgets">Order Management like assigning orders, picking, packing, shipping and collecting can be done through these endpoints.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Delivery Types</strong></p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Ship</div></li><li class="slate-li"><div style="position:relative">Collect</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Pipeline Stages</strong></p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">1 - Store Not Assigned</div></li><li class="slate-li"><div style="position:relative">2 - Pending Picker Assignment</div></li><li class="slate-li"><div style="position:relative">3 - Picking</div></li><li class="slate-li"><div style="position:relative">4 - Packing</div></li><li class="slate-li"><div style="position:relative">5 - Not Located</div></li><li class="slate-li"><div style="position:relative">6 - Returned</div></li><li class="slate-li"><div style="position:relative">7 - Refunded</div></li><li class="slate-li"><div style="position:relative">8 - Delivering</div></li><li class="slate-li"><div style="position:relative">9 - Delivered</div></li><li class="slate-li"><div style="position:relative">10 - Inter store Awaiting</div></li><li class="slate-li"><div style="position:relative">11 - Inter store Ready</div></li><li class="slate-li"><div style="position:relative">12 - Inter store Shipped</div></li><li class="slate-li"><div style="position:relative">13 - Inter store Arrived</div></li><li class="slate-li"><div style="position:relative">15 - Picked</div></li><li class="slate-li"><div style="position:relative">16 - Scanned For Packing</div></li><li class="slate-li"><div style="position:relative">17 - Label Printed</div></li><li class="slate-li"><div style="position:relative">19 - Out of Stock</div></li><li class="slate-li"><div style="position:relative">20 - Packed</div></li><li class="slate-li"><div style="position:relative">23 - Bin Assigned</div></li><li class="slate-li"><div style="position:relative">24 - Null Receive</div></li><li class="slate-li"><div style="position:relative">26 - Replaced</div></li><li class="slate-li"><div style="position:relative">31 - Cancelled</div></li><li class="slate-li"><div style="position:relative">50 - Awaiting Item Pickup</div></li><li class="slate-li"><div style="position:relative">51 - Item Pick up</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p>

OMS V3 works around orders. The beginning of transaction in RANDEM OMS is when an order went through the app.

Order Management like assigning orders, picking, packing, shipping and collecting can be done through these endpoints.

<div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p" placeholder="Type / for widgets">Locations in RANDEM Retail V3 - API is sometimes known as stores, warehouses or branches. The data here also contains Location Products which is the assigning of available products on each location. Location Users are users that is assigned to a specific location, assigning user to a specific location limits its access within the location.</p><p class="slate-p" placeholder="Type / for widgets">Location Operating Hours will be the availability schedule of pickup in a location.</p><p class="slate-p" placeholder="Type / for widgets">Location Holiday is where user can assign a specific date for the location to be available on a certain hours or whole day or vice versa, it means location can also be disabled using this feature.</p><p class="slate-p" placeholder="Type / for widgets">Location Bins and Location Benches can be optional. Some businesses are using the bins and benches storage process.</p><p class="slate-p" placeholder="Type / for widgets"></p>

Locations in RANDEM Retail V3 - API is sometimes known as stores, warehouses or branches. The data here also contains Location Products which is the assigning of available products on each location. Location Users are users that is assigned to a specific location, assigning user to a specific location limits its access within the location.

Location Operating Hours will be the availability schedule of pickup in a location.

Location Holiday is where user can assign a specific date for the location to be available on a certain hours or whole day or vice versa, it means location can also be disabled using this feature.

Location Bins and Location Benches can be optional. Some businesses are using the bins and benches storage process.

<p class="slate-p" placeholder="Type / for widgets">RANDEM OMS Users are eligible operators of the application. User Roles are also implemented to restrict specific user from some modules.</p>

RANDEM OMS Users are eligible operators of the application. User Roles are also implemented to restrict specific user from some modules.

<p class="slate-p" placeholder="Type / for widgets">Return list of users available in the installation. Filter users by keyword, page number and limit.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Return list of users available in the installation. Filter users by keyword, page number and limit.

Authorization

Keyword

Page

Limit

data

currentPage

numberOfPages

itemsPerPage

totalItems

totalDisabled

totalEnabled

lastPage

hasNextPage

hasLastPage

channelProvider

installationDomain

storeHash

userId

firstName

lastName

phone

email

status

permissions

groupRoleId

createdOn

updatedOn

roles

assignedStores

newPassword

oldPassword

userPermissions

locationId

userLocationGroupRoleId

locationPermissions

<p class="slate-p" placeholder="Type / for widgets">The main purpose of inventory is to allocate and check stock availability in each location. Next to orders and location, inventory is the next important part of RANDEM OMS.</p><p class="slate-p" placeholder="Type / for widgets"></p>

The main purpose of inventory is to allocate and check stock availability in each location. Next to orders and location, inventory is the next important part of RANDEM OMS.

<p class="slate-p" placeholder="Type / for widgets">There are 2 types of Packages used in RANDEM OMS V3.

We have Type 1 which is Box and Type 2 for Bag.

Sample Return for Bag</p><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-229-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="keep-markup drop-tokens"><div class="slate-code_line">{
        &quot;boxId&quot;: &quot;e70c36ef-559a-4f71-9e3b-ec4436724d01&quot;,
        &quot;boxCode&quot;: &quot;BAG1&quot;,
        &quot;height&quot;: 100,
        &quot;width&quot;: 100,
        &quot;depth&quot;: 100,
        &quot;type&quot;: 2,
        &quot;dimensionUnit&quot;: null,
        &quot;weight&quot;: null,
        &quot;weightUnit&quot;: null,
        &quot;isCustomBox&quot;: false
    }</div></code></pre><p class="slate-p" placeholder="Type / for widgets">Sample Return for Box</p><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-230-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="keep-markup drop-tokens"><div class="slate-code_line">{
        &quot;boxId&quot;: &quot;0c868125-5ab3-4650-9ae3-f04b1140de9f&quot;,
        &quot;boxCode&quot;: &quot;Box 2&quot;,
        &quot;height&quot;: 200,
        &quot;width&quot;: 200,
        &quot;depth&quot;: 200,
        &quot;type&quot;: 1,
        &quot;dimensionUnit&quot;: null,
        &quot;weight&quot;: null,
        &quot;weightUnit&quot;: null,
        &quot;isCustomBox&quot;: false
    }</div></code></pre><p class="slate-p" placeholder="Type / for widgets"></p>

There are 2 types of Packages used in RANDEM OMS V3.

We have Type 1 which is Box and Type 2 for Bag.

Sample Return for Bag

Sections