Get inventory status (v0.0.1)

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

Query GET Request

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

74 properties
productId string
required

The unique identifier for the product

productMetadata object
required
sku string
required

Stock keeping unit

barcode string
required

Product barcode (UPC/EAN)

Match pattern: ^[0-9]{12,13}$
category object
required
primary string
required

Primary category

secondary string

Secondary category

tags array [string]

Category tags

dimensions object
required
length number
required

Length in centimeters

Minimum: 0
width number
required

Width in centimeters

Minimum: 0
height number
required

Height in centimeters

Minimum: 0
weight number
required

Weight in grams

Minimum: 0
aggregatedInventory object
required
totalAvailable integer
required

Total available quantity across all locations

Minimum: 0
totalReserved integer
required

Total reserved quantity across all locations

Minimum: 0
totalInTransit integer
required

Total quantity in transit between locations

Minimum: 0
safetyStock integer
required

Safety stock level

Minimum: 0
reorderLevel integer
required

Reorder point threshold

Minimum: 0
locationBreakdown array [object]
required

Inventory breakdown by location

Item Details:
location object → LocationDetails
required
facilityId string
required

Facility identifier in format CC0000

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

Facility name

zone string
required

Geographic zone

Allowed values: north south east west central
coordinates object → Coordinates
required
latitude number
required

Latitude coordinate

Minimum: -90
Maximum: 90
longitude number
required

Longitude coordinate

Minimum: -180
Maximum: 180
operatingHours object
required
openTime string
required

Opening time in HH:MM format

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

Closing time in HH:MM format

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

Time zone identifier

inventory object
required
availableQuantity integer
required

Available quantity at this location

Minimum: 0
reservedQuantity integer
required

Reserved quantity at this location

Minimum: 0
lastCountDate string <date>
required

Date of last physical count

qualityMetrics object → QualityMetrics
required
inspectionDate string <date>
required

Date of last quality inspection

grade string
required

Quality grade

Allowed values: A B C D F
defectRate number
required

Defect rate percentage

Minimum: 0
Maximum: 100
expirationTracking object
required
hasExpiration boolean
required

Whether product has expiration date

nearExpiryCount integer

Count of items near expiration

Minimum: 0
expiredCount integer

Count of expired items

Minimum: 0
supplierInformation array [object]
required

Information about suppliers for this product

Item Details:
supplierId string
required

Unique supplier identifier

companyName string
required

Supplier company name

tier string
required

Supplier tier level

Allowed values: primary secondary backup
performance object
required
onTimeDelivery number
required

On-time delivery percentage

Minimum: 0
Maximum: 100
qualityRating number
required

Quality rating (1-5 stars)

Minimum: 1
Maximum: 5
lastDeliveryDate string <date>

Date of last delivery

contractTerms object
required
minimumOrderQuantity integer
required

Minimum order quantity

Minimum: 1
pricePerUnit number
required

Price per unit in USD

Minimum: 0
currency string
required

Currency code

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

Recent inventory movements (last 10)

Item Details:
movementId string
required

Unique movement identifier

type string
required

Type of inventory movement

Allowed values: inbound outbound transfer adjustment
quantity integer
required

Quantity moved (positive for inbound, negative for outbound)

timestamp string <date-time>
required

When the movement occurred

reason string
required

Reason for the movement

reference object
orderId string

Related order ID if applicable

transferId string

Related transfer ID if applicable

userId string

User who initiated the movement

alerts object
required
lowStock boolean
required

Whether product is below reorder level

qualityIssues boolean
required

Whether there are quality concerns

supplierDelays boolean
required

Whether there are supplier delivery delays

messages array [object]
required

Alert messages

Item Details:
severity string
required

Alert severity level

Allowed values: info warning error critical
message string
required

Alert message

timestamp string <date-time>
required

When the alert was generated

lastUpdated string <date-time>
required

Timestamp when this data was last updated

Edit this page