Skip to main content
API docs by Redocly

Product Inventory Service (v2025.11.06-3)

Download OpenAPI specification:Download

Get Product Inventory

Requests current product inventory details from Logitrail WMS

Authorizations:
idp
path Parameters
productId
required
string^[a-f0-9]{24}$
header Parameters
x-logitrail-merchant-id
required
string (Logitrail's Merchant ID the request is scoped for.)

Responses

Response samples

Content type
application/json
{
  • "product_inventory": {
    }
}

Get Product Arrival Batches on shelf

Requests information about the Arrival Batches of a product that are currently stocked on shelf in the warehouse. Arrival Batches represent a specific batch of items that arrived together and are managed as a group within the warehouse. This endpoint provides details about these batches, including their quantities, locations, and other relevant information. Arrival Batches are most likely different from supplier batches / lot numbers and internal to Logitrail warehouse operations. For example, there may be more than one Arrival Batch for a product batch with "best before date" 2026-31-12 with supplier lot number 12345. Anyway, same Arrival Batch never contains multiple supplier lots or multiple products.

Authorizations:
idp
path Parameters
productId
required
string^[a-f0-9]{24}$
header Parameters
x-logitrail-merchant-id
required
string (Logitrail's Merchant ID the request is scoped for.)

Responses

Response samples

Content type
application/json
{
  • "batches_on_shelf": [
    ]
}

Update Product Arrival Batch

Update the details of a specific product arrival batch. Note that a new Arrival Batch is generated whenever new items arrive and they are stocked in Logitrail warehouse.

Authorizations:
idp
path Parameters
productId
required
string^[a-f0-9]{24}$
batchId
required
number
header Parameters
x-logitrail-merchant-id
required
string (Logitrail's Merchant ID the request is scoped for.)

Responses

Response samples

Content type
application/json
{
  • "batch": {
    }
}