/warehouses v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Warehouses
getWarehouses
Code samples
const headers = {
Accept: "application/json",
};
fetch("https://goldleaf.app/api/v1/warehouses", {
method: "GET",
headers: headers,
})
.then(function (res) {
return res.json();
})
.then(function (body) {
console.log(body);
});
GET /warehouses
Retrieve a list of warehouses
Fetch a paginated list of warehouses with optional filtering by name. Only non-customer roles are allowed to access this endpoint.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | integer | false | Page number for pagination. |
| limit | query | integer | false | Number of items per page. |
| search.name | query | string | false | Filter warehouses by name. |
Example responses
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A list of warehouses | None |
| 400 | Bad Request | Validation error | None |
| 401 | Unauthorized | Unauthorized (missing or invalid token) | None |
| 403 | Forbidden | Forbidden (user role not allowed) | None |
| 500 | Internal Server Error | Server error | None |
