MACH Booster Inventory API (v0)

Download OpenAPI specification:Download

This project is a microservice designed for managing inventory in high-throughput environments. Unlike traditional warehouse inventory systems that include complex logistics and inventory balancing features, this service focuses on maintaining a streamlined dataset to track availability across different inventory locations (referred to as Nodes within the industry). The primary aim is to support online experiences, where rapid and numerous API calls are expected. The inventory availability is dynamically updated to reflect online sales and stock refreshes from physical stores as they happen.

Inventory

updateInventoryForNodeAndRemoveAllReservations

Update Inventory for Node and Remove All Reservations

This API method is designed to update the inventory level for a specific inventory location (Node) and simultaneously remove all existing reservations associated with that Node. This operation is crucial for scenarios where inventory data needs to be refreshed or corrected, ensuring that the inventory levels accurately reflect the current stock without the constraints of prior reservations.

path Parameters
sku
required
string
nodeId
required
string
amount
required
string

Responses

reserveAvailabilityForOrder

Reserve Inventory Availability for an Order

This API method allows for the reservation of inventory for a specific order. It is designed to allocate inventory to an order, ensuring that the items are available for fulfillment. This reservation helps manage inventory levels effectively and prevent overselling.

path Parameters
cartId
required
string
Request Body schema: application/json
required
cartId
string
Array of objects (LineItemRequest)

Responses

Request samples

Content type
application/json
{
  • "cartId": "string",
  • "items": [
    ]
}

addInventory

Add Inventory

The addInventory method is designed to increase the inventory level for a specific item at a designated inventory location, or Node. This method allows users to add new stock quantities to the existing inventory, ensuring that the system's inventory records are up to date with physical stock levels. It is particularly useful for updating inventory after receiving new shipments or restocking items.

Request Body schema: application/json
required
skuId
string
nodeId
string
productKey
string
quantityOnStock
number

Responses

Request samples

Content type
application/json
{
  • "skuId": "string",
  • "nodeId": "string",
  • "productKey": "string",
  • "quantityOnStock": 0
}

getAvailabilityBySkuIdForNodes

Get Availability By SkuId For Nodes

The getAvailabilityBySkuIdForNodes method is designed to fetch the inventory availability of a specific product, identified by its Stock Keeping Unit (SKU) ID, across multiple inventory locations or Nodes. This function is crucial for businesses that need to provide customers or internal systems with a comprehensive view of where a product is available and in what quantities, facilitating logistics, distribution planning, and enabling customers to make informed purchasing decisions based on product availability at different locations.

path Parameters
skuId
required
string
query Parameters
node
required
Array of strings

Responses

getAvailabilityByProductForNode

Get Availability By ProductID For Nodes

The getAvailabilityByProductForNode method retrieves the current inventory status of a specific product at a designated inventory location, or Node. This API endpoint is crucial for businesses needing precise, real-time information on product availability to manage stock levels efficiently and improve customer service by providing accurate inventory data.

path Parameters
productKey
required
string
query Parameters
node
required
string

Responses

getAvailabilityByCartId

Get Availability By CartID

The getAvailabilityByCartId method retrieves the current inventory availability for all items within a specified shopping cart. It is designed to provide real-time feedback on the stock levels of items that customers are interested in purchasing, ensuring that they are informed about the availability of their selected products before proceeding to checkout.

path Parameters
cartId
required
string
query Parameters
required
object (CartRequest)

Responses

getAvailabilityByCartIdOnNode

Get Availability By CartId On Node

The getAvailabilityByCartIdOnNode method provides a targeted approach to checking inventory availability, focusing on the items within a specific shopping cart and their stock levels at a particular inventory location or Node. This functionality is essential for businesses that manage multiple inventory locations and need to offer customers precise information about where items can be picked up or shipped from.

Responses

removeReservationsForCartItems

Remove Reservations For Cart Items

The removeReservationsForCartItems method is designed to release any inventory reservations held for items within a specific shopping cart. This API endpoint plays a crucial role in inventory management systems, especially in scenarios where a customer decides not to proceed with a purchase, or a reserved inventory needs to be freed up for other potential sales.

path Parameters
cartId
required
string
query Parameters
lines
Array of strings

Responses