Returns the bin with the given identifier, with its live utilization.

GET /inventory/bins/{id}

Group: Inventory › Bins · Operation ID: getBin

This endpoint returns capacity, the bin's live utilization, which no other endpoint returns. capacity is absent when the bin has no limit configured, because there is nothing to measure against, and such a bin accepts anything. Read capacity.mixedUnits before trusting capacity.currentQuantity: with more than one stocking unit in the bin, the quantity is a sum of unlike things and the weight and volume dimensions are the ones to use.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
id path string yes The unique identifier for the bin to return.

Response

200 Success

Under data (getBinOutput):

Field Type Required Description
id string yes The unique identifier for the bin.
binCode string no The short code that identifies the bin, for example 'A-01-1'. It is unique within the tenant, not per warehouse, and cannot be changed after the bin is created.
barcode string no The barcode printed on the bin label. It is unique within the tenant and cannot be changed after the bin is created.
locationId string no The unique identifier for the warehouse the bin is in. It cannot be changed after the bin is created. See id on GET inventory/warehouses/:id.
locationCode string no The code of that warehouse.
locationName string no The name of that warehouse.
aisle string no The aisle in the warehouse layout.
rack string no The rack within the aisle.
shelfLevel string no The shelf level within the rack.
zone string no The logical zone of the bin, as your tenant names them. For example 'Picking', 'Storage' or 'Quarantine'.
itemPosition string no The position within the shelf, where a bin is subdivided further.
isPickingBin boolean no Whether the bin is a picking location, a fast-access place stock is taken from to fulfill shipments.
isReceivingBin boolean no Whether the bin stages newly received goods before they are put away.
isProductionBin boolean no Whether the bin feeds or receives production.
maxQuantity number no The largest number of units the bin will hold. It is meaningful only when everything in the bin is counted in the same unit.
maxWeight string (decimal) no The largest weight the bin will hold, in maxWeightUnit.
maxWeightUnit string no The unit maxWeight is given in. Possible values: 'G', 'Kg', 'Lbs'.
maxVolume string (decimal) no The largest volume the bin will hold, in maxVolumeUnit.
maxVolumeUnit string no The unit maxVolume is given in. Possible values: 'L'.
capacityCheckMode string no What happens when a movement would exceed a limit. Possible values: 'HardBlock', which refuses the movement, and 'SoftWarning', which allows it and flags it.
tempZone string no The temperature zone the bin belongs to, as your tenant names them. For example 'Ambient', 'Chilled' or 'Frozen'.
tempMin string (decimal) no The lowest temperature kept in the bin, in degrees Celsius.
tempMax string (decimal) no The highest temperature kept in the bin, in degrees Celsius.
supportsPerishable boolean no Whether perishable stock may be kept in the bin.
active boolean no Whether the bin may be chosen for new movements. When false, the stock already in the bin stays there but no new movement can be assigned to it.
createdDate string (date-time) no The date and time the bin was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lastModifiedDate string (date-time) no The date and time the bin record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
capacity object no What is in the bin now, measured against what it will hold. Present on this endpoint only. Absent when the bin has no limit configured, because there is nothing to measure a utilization against.
capacity.currentQuantity string (decimal) no The number of units in the bin.
capacity.currentWeight string (decimal) no The total weight of what is in the bin, normalized to kilograms whatever unit the limit is given in.
capacity.currentVolume string (decimal) no The total volume of what is in the bin, normalized to cubic meters.
capacity.quantityUtilizationPct string (decimal) no How full the bin is against maxQuantity, as a percentage.
capacity.weightUtilizationPct string (decimal) no How full the bin is against maxWeight, as a percentage.
capacity.volumeUtilizationPct string (decimal) no How full the bin is against maxVolume, as a percentage.
capacity.status string no How full the bin is overall. Possible values: 'ok', 'near_full', 'exceeded'. 'exceeded' means the bin is over a limit it was given, which is possible because a 'SoftWarning' bin allows the movement that crosses the limit.
capacity.mixedUnits boolean no Whether the bin holds items counted in more than one stocking unit. When true, currentQuantity is a sum of unlike things and the quantity utilization means nothing, so use the weight and volume instead.

Errors

Code Status
NOT_FOUND 400

Statuses