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"
}'
Schema
The unique identifier for the product
Stock keeping unit
Product barcode (UPC/EAN)
^[0-9]{12,13}$
Primary category
Secondary category
Category tags
Length in centimeters
0
Width in centimeters
0
Height in centimeters
0
Weight in grams
0
Total available quantity across all locations
0
Total reserved quantity across all locations
0
Total quantity in transit between locations
0
Safety stock level
0
Reorder point threshold
0
Inventory breakdown by location
Facility identifier in format CC0000
^[A-Z]{2}[0-9]{4}$
Facility name
Geographic zone
north
south
east
west
central
Latitude coordinate
-90
90
Longitude coordinate
-180
180
Opening time in HH:MM format
^([01]?[0-9]|2[0-3]):[0-5][0-9]$
Closing time in HH:MM format
^([01]?[0-9]|2[0-3]):[0-5][0-9]$
Time zone identifier
Available quantity at this location
0
Reserved quantity at this location
0
Date of last physical count
Date of last quality inspection
Quality grade
A
B
C
D
F
Defect rate percentage
0
100
Whether product has expiration date
Count of items near expiration
0
Count of expired items
0
Information about suppliers for this product
Unique supplier identifier
Supplier company name
Supplier tier level
primary
secondary
backup
On-time delivery percentage
0
100
Quality rating (1-5 stars)
1
5
Date of last delivery
Minimum order quantity
1
Price per unit in USD
0
Currency code
USD
EUR
GBP
CAD
JPY
Recent inventory movements (last 10)
Unique movement identifier
Type of inventory movement
inbound
outbound
transfer
adjustment
Quantity moved (positive for inbound, negative for outbound)
When the movement occurred
Reason for the movement
Related order ID if applicable
Related transfer ID if applicable
User who initiated the movement
Whether product is below reorder level
Whether there are quality concerns
Whether there are supplier delivery delays
Alert messages
Alert severity level
info
warning
error
critical
Alert message
When the alert was generated
Timestamp when this data was last updated
No properties match your search
Try a different search term or clear the search to see all properties