Get Product Inventory Profile
GET/api/v1/products/:id/inventory-profile
Retrieve the inventory profile of one product, covering stock settings, default locations, per-location stock, tracking policy, vendor terms and barcode. Requires scope crm:read and the Products view permission on this product. Available only when inventory is enabled for the company.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
- 503
Success
Canonical personal-token bad request, including PUBLIC_POSITION_REQUIRED or PUBLIC_ACTOR_OVERRIDE_NOT_ALLOWED.
The Bearer personal token is missing, malformed, inactive, expired, revoked, or CIDR-blocked. Personal-token 401 responses include the Bearer challenge. Temporary validation outages return 503 instead.
Response Headers
Canonical personal-token authorization denial, including unavailable or unauthorized position selection.
Product not found
Rate limit exceeded
Response Headers
Active public API plan applied to the request. Free and Kickstarter are blocked before rate buckets are consumed.
Rate-limit bucket used for the request. List-style POST endpoints are counted as reads; mutation endpoints are counted as writes.
Maximum number of requests allowed for the active bucket in the current one-second rate-limit window.
Maximum read requests allowed per second for the active plan. Pro is 100; Unlimited is 500.
Maximum write requests allowed per second for the active plan. Pro is 25; Unlimited is 125.
Number of requests remaining for the active bucket in the current one-second rate-limit window.
Unix timestamp, in seconds, when the current rate-limit window resets.
HTTP date when the current limit resets. Present on 429 responses.
Internal Server Error
Personal access token validation is temporarily unavailable.