Get inventory status (v0.0.1)

GET request that will return the current stock status for a specific product.

Overview

The GetInventoryStatus message is a query designed to retrieve the current stock status for a specific product.

This query provides detailed information about the available quantity, reserved quantity, and the warehouse location where the product is stored. It is typically used by systems or services that need to determine the real-time availability of a product, enabling efficient stock management, order fulfillment, and inventory tracking processes.

This query is essential for ensuring accurate stock levels are reported to downstream systems, including e-commerce platforms, warehouse management systems, and sales channels.

Query using CURL

Use this snippet to query the inventory status

curl -X GET "https://api.yourdomain.com/inventory/status" \
-H "Content-Type: application/json" \
-d '{
  "productId": "12345"
}'

JSON Schema

4 properties
productId string
required

The unique identifier for the product

availableQuantity integer
required

The quantity of the product currently available in stock

Minimum: 0
reservedQuantity integer
required

The quantity of the product that is reserved for pending orders

Minimum: 0
warehouseLocation string
required

The location of the warehouse where the product is stored