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

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

Schema

74 properties
productIdstring
required

The unique identifier for the product

productMetadataobject
required
skustring
required

Stock keeping unit

barcodestring
required

Product barcode (UPC/EAN)

Match pattern: ^[0-9]{12,13}$
categoryobject
required
primarystring
required

Primary category

secondarystring

Secondary category

tagsarray[string]

Category tags

dimensionsobject
required
lengthnumber
required

Length in centimeters

Minimum: 0
widthnumber
required

Width in centimeters

Minimum: 0
heightnumber
required

Height in centimeters

Minimum: 0
weightnumber
required

Weight in grams

Minimum: 0
aggregatedInventoryobject
required
totalAvailableinteger
required

Total available quantity across all locations

Minimum: 0
totalReservedinteger
required

Total reserved quantity across all locations

Minimum: 0
totalInTransitinteger
required

Total quantity in transit between locations

Minimum: 0
safetyStockinteger
required

Safety stock level

Minimum: 0
reorderLevelinteger
required

Reorder point threshold

Minimum: 0
locationBreakdownarray[object]
required

Inventory breakdown by location

Item Details:
locationobjectLocationDetails
required
facilityIdstring
required

Facility identifier in format CC0000

Match pattern: ^[A-Z]{2}[0-9]{4}$
namestring
required

Facility name

zonestring
required

Geographic zone

Allowed values: north south east west central
coordinatesobjectCoordinates
required
latitudenumber
required

Latitude coordinate

Minimum: -90
Maximum: 90
longitudenumber
required

Longitude coordinate

Minimum: -180
Maximum: 180
operatingHoursobject
required
openTimestring
required

Opening time in HH:MM format

Match pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]$
closeTimestring
required

Closing time in HH:MM format

Match pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]$
timeZonestring
required

Time zone identifier

inventoryobject
required
availableQuantityinteger
required

Available quantity at this location

Minimum: 0
reservedQuantityinteger
required

Reserved quantity at this location

Minimum: 0
lastCountDatestring<date>
required

Date of last physical count

qualityMetricsobjectQualityMetrics
required
inspectionDatestring<date>
required

Date of last quality inspection

gradestring
required

Quality grade

Allowed values: A B C D F
defectRatenumber
required

Defect rate percentage

Minimum: 0
Maximum: 100
expirationTrackingobject
required
hasExpirationboolean
required

Whether product has expiration date

nearExpiryCountinteger

Count of items near expiration

Minimum: 0
expiredCountinteger

Count of expired items

Minimum: 0
supplierInformationarray[object]
required

Information about suppliers for this product

Item Details:
supplierIdstring
required

Unique supplier identifier

companyNamestring
required

Supplier company name

tierstring
required

Supplier tier level

Allowed values: primary secondary backup
performanceobject
required
onTimeDeliverynumber
required

On-time delivery percentage

Minimum: 0
Maximum: 100
qualityRatingnumber
required

Quality rating (1-5 stars)

Minimum: 1
Maximum: 5
lastDeliveryDatestring<date>

Date of last delivery

contractTermsobject
required
minimumOrderQuantityinteger
required

Minimum order quantity

Minimum: 1
pricePerUnitnumber
required

Price per unit in USD

Minimum: 0
currencystring
required

Currency code

Allowed values: USD EUR GBP CAD JPY
recentMovementsarray[object]
required

Recent inventory movements (last 10)

Item Details:
movementIdstring
required

Unique movement identifier

typestring
required

Type of inventory movement

Allowed values: inbound outbound transfer adjustment
quantityinteger
required

Quantity moved (positive for inbound, negative for outbound)

timestampstring<date-time>
required

When the movement occurred

reasonstring
required

Reason for the movement

referenceobject
orderIdstring

Related order ID if applicable

transferIdstring

Related transfer ID if applicable

userIdstring

User who initiated the movement

alertsobject
required
lowStockboolean
required

Whether product is below reorder level

qualityIssuesboolean
required

Whether there are quality concerns

supplierDelaysboolean
required

Whether there are supplier delivery delays

messagesarray[object]
required

Alert messages

Item Details:
severitystring
required

Alert severity level

Allowed values: info warning error critical
messagestring
required

Alert message

timestampstring<date-time>
required

When the alert was generated

lastUpdatedstring<date-time>
required

Timestamp when this data was last updated