Skip to main content
GET
Get product stock status by ProductCode or EcommerceCode
Same report as Get product stock status; use this route when you only have the product’s ProductCode or its e-commerce integration code (EcommerceCode) rather than its ID.
  • Exactly one of ProductCode/EcommerceCode is required.
  • All other behavior (WarehouseName, Quantity, Lots, SerialNumbers, UnitCode) is identical to Get product stock status.

Error codes

Codes this endpoint can return. The general errors that apply to every endpoint (authentication, permissions, request headers, daily limit) are not repeated here.

Authorizations

Authorization
string
header
required

Access token obtained from the Noyax auth service with your API key.

Headers

X-UserID
integer<int32>
required

ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.

Required range: x >= 1
X-CompanyID
integer<int32>
required

ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.

Required range: x >= 1
X-PeriodID
integer<int32>

ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.

Required range: x >= 1

Query Parameters

productCode
string

Product code (the product's Code from GET /api/v1/products).

eCommerceCode
string

The product's e-commerce integration code (EcommerceProductCode from GET /api/v1/products).

warehouseName
string

Only count movements in this warehouse (name from GET /api/v1/stock/warehouses). When empty, all warehouses are included.

Response

OK

Success
boolean
required

Whether the operation succeeded.

Example:

true

ResultCode
string
required

"0000" on success. On failure, the code of the first error; all errors are listed in Errors.

Example:

"0000"

Data
object
required

Response data. Null when Success is false.

Message
null | string

Error message when Success is false. Messages of all errors are joined into a single text.