Skip to main content
GET
/
v1
/
warehouses
List warehouses
curl --request GET \
  --url https://api.algure.com/v1/warehouses \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "name": "<string>",
    "id": 123,
    "code": "<string>",
    "slug": "<string>",
    "timezone": "<string>",
    "countingWeekdays": [
      123
    ],
    "dailyProductCount": 123,
    "countingTimeHour": 123,
    "countingTimeMinute": 123,
    "countingTimeOffset": 123,
    "countingDurationHour": 123,
    "bypassCountingSchedule": true,
    "discrepancyThresholdStock": 123,
    "discrepancyThresholdValue": 123,
    "totalCountableProducts": 123
  }
]

Authorizations

Authorization
string
header
required

Use Integration API credentials as HTTP Basic auth (username: client id, password: client secret).

Response

200 - application/json

The warehouse list

name
string
required

Human-readable warehouse name

id
number
required

Warehouse internal numeric identifier

code
string
required

Unique warehouse code within an organization

slug
string
required

URL-safe warehouse slug within an organization

timezone
string
required

IANA timezone used for warehouse schedules

countingWeekdays
number[]
required

Weekdays when counting is enabled (1-7)

dailyProductCount
number
required

Daily number of products expected to be counted

countingTimeHour
number
required

Counting start hour in local warehouse time

countingTimeMinute
number
required

Counting start minute in local warehouse time

countingTimeOffset
number
required

Additional schedule offset in hours

countingDurationHour
number
required

Counting session duration in hours

bypassCountingSchedule
boolean
required

Whether counting schedule restrictions are bypassed

discrepancyThresholdStock
number
required

Stock threshold used to flag counting discrepancies

discrepancyThresholdValue
number
required

Value threshold used to flag counting discrepancies

totalCountableProducts
number
required

Total products eligible for countings