Get Inventory by Product ID

Retrieves the current inventory levels for a specific product across all locations.

The response includes stock information for each location where the product has inventory, including:

  • On Hand: Total physical quantity available
  • Reserved: Quantity allocated to orders
  • Unavailable: Quantity not available for sale

Use this endpoint to check real-time stock availability before allocating orders or to sync inventory data with external systems.

SecurityOAuth2-Production or OAuth2-Demo
Request
path Parameters
product-id
required
string

The unique identifier of the product to retrieve inventory for.

header Parameters
x-api-key
required
string

Your Carriyo API key for authentication.

tenant-id
required
string

Your unique tenant identifier in Carriyo.

Content-Type
string
Default: application/json
Responses
200

Successfully retrieved inventory for the product.

404

No inventory found for the specified product ID.

get/inventory/product-id/{product-id}
Request samples 
Response samples 
application/json
{
  • "tenant": "string",
  • "product_id": "string",
  • "stock_by_location": {
    },
  • "creation_date": "2019-08-24T14:15:22Z",
  • "update_date": "2019-08-24T14:15:22Z",
  • "creation_source": {
    },
  • "update_source": {
    }
}