Warehouses

List Warehouses

List all warehouses.

GET

/v1/warehouses

List Warehouses

curl --request GET \
  --url 'https://public-api.bladepro.io/v1/warehouses?expand=%3Cstring%3E'

{
  "data": [
    {
      "active": true,
      "country": {
        "block": "EU",
        "currency_id": 1,
        "id": 1,
        "iso_2": "GB",
        "iso_3": "GBR",
        "name": "United Kingdom",
        "region_id": 1
      },
      "country_id": 1,
      "created": "2019-11-25T14:52:56.000Z",
      "currency": {
        "code": "GBP",
        "created": "2019-11-25T14:52:56.000Z",
        "id": 1,
        "modified": "2019-11-25T14:52:56.000Z",
        "name": "Great British Pounds",
        "symbol": "£"
      },
      "currency_id": 1,
      "id": 1,
      "latitude": 50.739492,
      "longitude": -1.734224,
      "modified": "2019-11-25T14:52:56.000Z",
      "name": "Christchurch",
      "return_warehouse_id": 1,
      "short_code": "CHR",
      "virtual": false
    }
  ],
  "meta": {
    "paging": {
      "page": 1,
      "per_page": 250,
      "records": 1,
      "total_pages": 1,
      "total_records": 1
    },
    "request_reference": "233f2gjwz-c893v86"
  }
}

Fuzzy search available

Scope(s): APP::MISC

Query Parameters

expandstringquery

Usage: expand=*

Expand country, currency

Response

successful operation

activeboolean

Is the warehouse switched on?

countryobject

The warehouse's country.

Show child attributes

country_idnumber

ID of the warehouse's country.

createdany

Created timestamp in BladePRO.

currencyobject

The warehouse's currency.

Show child attributes

currency_idnumber

ID of the warehouse's currency.

idnumber

The warehouse's unique identifier.

latitudenumber

Latitude coordinate.

longitudenumber

Longitude coordinate.

modifiedany

Last modified timestamp in BladePRO.

namestring

Name.

return_warehouseobject

The return warehouse, if the returns for this warehouse are redirected.

return_warehouse_idnumber

ID of the return warehouse, if the returns for this warehouse are redirected.

short_codestring

Unique short code.

virtualboolean

Is the warehouse virtual?

Still need help? Share an idea