OMS by RANDEMRETAIL v3 - Management APIs

## Sections
• [API Reference](https://management.developers.randemretail.online/api-reference.md): 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. The Core APIs are Orders and Locations. 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.
• [Authentication](https://management.developers.randemretail.online/authentication.md): A token is needed to access the Management API. Most of the Transactional API is here, that is why more secured authentication is required.
• [Order](https://management.developers.randemretail.online/order.md): 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. Delivery Types Ship Collect Pipeline Stages 1 - Store Not Assigned 2 - Pending Picker Assignment 3 - Picking 4 - Packing 5 - Not Located 6 - Returned 7 - Refunded 8 - Delivering 9 - Delivered 10 - Inter store Awaiting 11 - Inter store Ready 12 - Inter store Shipped 13 - Inter store Arrived 15 - Picked 16 - Scanned For Packing 17 - Label Printed 19 - Out of Stock 20 - Packed 23 - Bin Assigned 24 - Null Receive 26 - Replaced 31 - Cancelled 50 - Awaiting Item Pickup 51 - Item Pick up
  • [Click And Collect](https://management.developers.randemretail.online/order/click-and-collect.md): Click and collect are orders that are requested to be picked up on a specific location.
    • [Get Completed Orders](https://management.developers.randemretail.online/order/click-and-collect/get-completed-orders.md): Retrieves click and collect orders that are already collected by customers.
    • [Get Overdue Orders](https://management.developers.randemretail.online/order/click-and-collect/get-overdue-orders.md): Click and collect orders has a pickup date to when the customer will collect the order. If items are not collected on or before the pickup date it will go to overdue orders.
    • [Get Ready for Collection Orders](https://management.developers.randemretail.online/order/click-and-collect/get-ready-for-collection-orders.md)
    • [Collect an Order](https://management.developers.randemretail.online/order/click-and-collect/collect-an-order.md): Accepts multiple order item ids. Orders with delivery type collect can use this endpoint to complete the transaction.
  • [Order History](https://management.developers.randemretail.online/order/order-history.md): Every update happened on an order and order items are being recorded including the notifications sent to customers.
    • [Get Order History](https://management.developers.randemretail.online/order/order-history/get-order-history.md): Return list of transactions happened in an order.
    • [Get Order Item History](https://management.developers.randemretail.online/order/order-history/get-order-item-history.md)
  • [Order Items](https://management.developers.randemretail.online/order/order-items.md)
• [Location](https://management.developers.randemretail.online/location.md): 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.
  • [Get Locations](https://management.developers.randemretail.online/location/get-locations.md): Retrieves all locations in an installation.
  • [Get a Location](https://management.developers.randemretail.online/location/get-a-location.md): Retrieves a specific location.
  • [Create a Location](https://management.developers.randemretail.online/location/create-a-location.md): Accepts location information and saves it.
  • [Update a Location](https://management.developers.randemretail.online/location/update-a-location.md): Accepts existing location with new information and updates it.
  • [Delete a Location](https://management.developers.randemretail.online/location/delete-a-location.md): Deletes a location.
  • [Location Product](https://management.developers.randemretail.online/location/location-product.md): Location Products is the assigning of available products on each location.
    • [Get Products](https://management.developers.randemretail.online/location/location-product/get-products-1.md): Retrieves all products assigned to a location.
    • [Upsert a Product](https://management.developers.randemretail.online/location/location-product/upsert-a-product.md): Creating a Location Product assigns a product to a specific location. Existing Location Product updates the information. e.g stocks, allowing shipment or allowing pickup.
    • [Search a Product by SKU](https://management.developers.randemretail.online/location/location-product/search-a-product-by-sku.md): Searching Location Products by SKU. This API returns all locations information regarding the SKU.
  • [Location User](https://management.developers.randemretail.online/location/location-user.md): Location Users are users that is assigned to a specific location, assigning user to a specific location limits its access within the location.
    • [Get Users](https://management.developers.randemretail.online/location/location-user/get-users-1.md): Retrieves all users assigned to specific location.
    • [Get a User](https://management.developers.randemretail.online/location/location-user/get-a-user.md): Retrieves a specific user.
    • [Upsert a User](https://management.developers.randemretail.online/location/location-user/upsert-a-user.md): Updates existing user data while creating data for non-existing user data.
    • [Delete a User](https://management.developers.randemretail.online/location/location-user/delete-a-user.md): Deletes a user in a location.
  • [Location Operating Hour](https://management.developers.randemretail.online/location/location-operating-hour.md): Location Operating Hours will be the availability schedule of pickup in a location.
    • [Get Operating Hours](https://management.developers.randemretail.online/location/location-operating-hour/get-operating-hours.md): Retrieves all operating hours of a location.
    • [Create an Operating Hour](https://management.developers.randemretail.online/location/location-operating-hour/create-an-operating-hour.md): Creates an operating hour for a location.
    • [Update an Operating Hour](https://management.developers.randemretail.online/location/location-operating-hour/update-an-operating-hour.md): Updates an existing operating hour on a location.
    • [Delete an Operating Hour](https://management.developers.randemretail.online/location/location-operating-hour/delete-an-operating-hour.md): Deleting an operating hour affects the availability of a location.
  • [Location Holiday](https://management.developers.randemretail.online/location/location-holiday.md)
    • [Get Holidays](https://management.developers.randemretail.online/location/location-holiday/get-holidays-1.md): Retrieves all holidays assigned to a location.
    • [Upsert a Holiday](https://management.developers.randemretail.online/location/location-holiday/upsert-a-holiday.md): Updates an existing holiday data while creating new data for non-existing holiday for a specific location.
  • [Location Bin](https://management.developers.randemretail.online/location/location-bin.md)
    • [Get Bins](https://management.developers.randemretail.online/location/location-bin/get-bins.md): Retrieves all bins assigned to a location.
    • [Create a Bin](https://management.developers.randemretail.online/location/location-bin/create-a-bin.md): Create a bin for a specific location.
    • [Search a Bin](https://management.developers.randemretail.online/location/location-bin/search-a-bin.md): Ability to search bin using a parameter.
    • [Get a Bin](https://management.developers.randemretail.online/location/location-bin/get-a-bin.md): Retrieves a specific bin.
    • [Delete a Bin](https://management.developers.randemretail.online/location/location-bin/delete-a-bin.md): Deletes a bin for a specific location.
    • [Download Bin QR Code](https://management.developers.randemretail.online/location/location-bin/download-bin-qr-code.md): Returns a .png format image of a QR Code with Bin Information.
  • [Location Bench](https://management.developers.randemretail.online/location/location-bench-1.md)
    • [Search Benches](https://management.developers.randemretail.online/location/location-bench-1/search-benches.md): Ability to search benches by parameter.
    • [Get Benches](https://management.developers.randemretail.online/location/location-bench-1/get-benches.md): Retrieves all benches on a specific location.
    • [Create a Bench](https://management.developers.randemretail.online/location/location-bench-1/create-a-bench.md): Creates a bench for a specific location.
    • [Update a Bench](https://management.developers.randemretail.online/location/location-bench-1/update-a-bench.md): Updates an existing bench on a specific location
    • [Delete a Bench](https://management.developers.randemretail.online/location/location-bench-1/delete-a-bench.md): Deletes a bench on a specific location.
    • [Download a Bench QR Code](https://management.developers.randemretail.online/location/location-bench-1/download-a-bench-qr-code-1.md): Returns a .png format image of a QR Code with Bench Information.
• [User](https://management.developers.randemretail.online/user.md): RANDEM OMS Users are eligible operators of the application. User Roles are also implemented to restrict specific user from some modules.
  • [Get Users](https://management.developers.randemretail.online/user/get-users.md): Return list of users available in the installation. Filter users by keyword, page number and limit.
  • [Get Current User Installation](https://management.developers.randemretail.online/user/get-current-user-installation.md)
  • [Get User by UserId](https://management.developers.randemretail.online/user/get-user-by-userid.md)
  • [Get User Location](https://management.developers.randemretail.online/user/get-user-location.md)
  • [Update User Password](https://management.developers.randemretail.online/user/update-user-password.md)
  • [Delete Users](https://management.developers.randemretail.online/user/delete-users.md)
  • [Save User Roles](https://management.developers.randemretail.online/user/save-user-roles.md)
  • [Save User Locations](https://management.developers.randemretail.online/user/save-user-locations.md)
  • [Update User Roles](https://management.developers.randemretail.online/user/update-user-roles.md)
  • [Delete Users Location](https://management.developers.randemretail.online/user/delete-users-location.md)
  • [Roles](https://management.developers.randemretail.online/user/roles.md)
    • [Get Roles](https://management.developers.randemretail.online/user/roles/get-roles.md)
  • [GroupRoles](https://management.developers.randemretail.online/user/grouproles.md)
    • [Get Group Role](https://management.developers.randemretail.online/user/grouproles/get-group-role.md)
    • [Save Group Roles](https://management.developers.randemretail.online/user/grouproles/save-group-roles-1.md)
    • [Get Group Roles](https://management.developers.randemretail.online/user/grouproles/get-group-roles.md)
    • [Get User Group Roles By GroupRoleId](https://management.developers.randemretail.online/user/grouproles/get-user-group-roles-by-grouproleid.md)
    • [Get User Group Roles By GroupRoleName](https://management.developers.randemretail.online/user/grouproles/get-user-group-roles-by-grouprolename.md)
    • [Save Group Roles](https://management.developers.randemretail.online/user/grouproles/save-group-roles.md)
    • [Delete Group Role By Group Role Id](https://management.developers.randemretail.online/user/grouproles/delete-group-role-by-group-role-id.md)
    • [/user-service/api/group-roles/{grouproleid}](https://management.developers.randemretail.online/user/grouproles/user-service-api-group-roles-grouproleid.md)
  • [Picker](https://management.developers.randemretail.online/user/picker.md)
    • [Search Pickers](https://management.developers.randemretail.online/user/picker/search-pickers.md): Search Pickers Important Parameter LocationId
    • [Mark As Picked](https://management.developers.randemretail.online/user/picker/mark-as-picked.md)
    • [Pick Item](https://management.developers.randemretail.online/user/picker/pick-item.md)
• [Inventory](https://management.developers.randemretail.online/inventory.md): 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.
  • [Get All Products](https://management.developers.randemretail.online/inventory/get-all-products.md): Retrieves all inventory in all locations.
  • [Get Product By Id](https://management.developers.randemretail.online/inventory/get-inventory-by-id.md): Retrieves a inventory by product id
  • [Search a Product](https://management.developers.randemretail.online/inventory/search-a-product.md): Retrives specific inventory by criteria
  • [Search Inventory by Product Id](https://management.developers.randemretail.online/inventory/search-inventory-by-product-id.md)
  • [Get Inventory per Location](https://management.developers.randemretail.online/inventory/get-inventory-per-location.md): Retrieves inventory availability per location.
  • [Get Inventory Available for Replacement](https://management.developers.randemretail.online/inventory/get-inventory-available-for-replacement.md): Retrives specific inventory by searching replacement
• [Holiday](https://management.developers.randemretail.online/holiday.md)
  • [Get Holidays](https://management.developers.randemretail.online/holiday/get-holidays.md): This section of the Randem Retail V3 - Management API allows users to retrieve holiday information. Users can access a list of holidays, filtered by name, start date, end date, location ID, page number, and page size.
  • [Create a Holiday](https://management.developers.randemretail.online/holiday/create-a-holiday.md): The Randem Retail V3 - Management API's /holiday-service/api/holidays section allows users to manage holiday records. With this API, users can create, update, and delete holiday entries, specify the holiday name, date range, and whether it is active.
  • [Delete a Holiday](https://management.developers.randemretail.online/holiday/delete-a-holiday.md): This section of the Randem Retail V3 Management API allows users to delete a specific holiday by providing the holiday ID. By making use of this functionality, users can easily manage the holidays in their retail system, removing any unnecessary or outdated holiday information.
• [Packages](https://management.developers.randemretail.online/packages.md): 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 Select... { "boxId": "e70c36ef-559a-4f71-9e3b-ec4436724d01", "boxCode": "BAG1", "height": 100, "width": 100, "depth": 100, "type": 2, "dimensionUnit": null, "weight": null, "weightUnit": null, "isCustomBox": false } Sample Return for Box Select... { "boxId": "0c868125-5ab3-4650-9ae3-f04b1140de9f", "boxCode": "Box 2", "height": 200, "width": 200, "depth": 200, "type": 1, "dimensionUnit": null, "weight": null, "weightUnit": null, "isCustomBox": false }
  • [Get Boxes](https://management.developers.randemretail.online/packages/get-boxes.md): The /box-service/api/boxes section of the Randem Retail V3 - Management API allows users to create new boxes for packaging and shipping purposes. By providing relevant details such as box dimensions, weight, and type, users can easily generate customized boxes to meet their specific needs.
  • [Get a Box](https://management.developers.randemretail.online/packages/get-a-box.md): This section of the Randem Retail V3 - Management API allows users to retrieve information about a specific box. By providing the unique identifier of the box, users can access details such as its dimensions, weight, and contents.
  • [Search a Box](https://management.developers.randemretail.online/packages/search-a-box.md)
  • [Get Boxes w/ Filter](https://management.developers.randemretail.online/packages/get-boxes-w-filter.md): This section of the Randem Retail V3 - Management API allows users to retrieve information related to boxes. By making use of this functionality, users can access details on various boxes in the system, such as their dimensions, contents, and availability.
• [Interstore Transfer](https://management.developers.randemretail.online/interstore-transfer.md)
  • [Get Inter Store Orders](https://management.developers.randemretail.online/interstore-transfer/get-inter-store-orders.md): Retrieve orders that are awaiting to be processed. These orders are originally from other locations however original location was not able to fulfill.
  • [Get Pending Inter Store](https://management.developers.randemretail.online/interstore-transfer/get-pending-inter-store.md): Retrieve pending items to be processed in the selected store.
• [Refund](https://management.developers.randemretail.online/refund.md)
  • [Get Order Item Refund](https://management.developers.randemretail.online/refund/get-order-item-refund.md)
  • [Get Order Refund List](https://management.developers.randemretail.online/refund/get-order-refund-list.md)
  • [Order Item Refund Approval](https://management.developers.randemretail.online/refund/order-item-refund-approval.md)
  • [Shipping Refund](https://management.developers.randemretail.online/refund/shipping-refund.md)
  • [Refund Order Item/s](https://management.developers.randemretail.online/refund/refund-order-item-s.md): Accepts order items that are for refund.