Warehouses

Working with warehouses

List Warehouses

GET /v1/warehouses

List all warehouses.

Return Type

array<Warehouses>

Available expands

Field	Return Type	Description
`country`	`Countries`	A country.
`currency`	`Currencies`	Currency data.

Rate limit cost

Each call to this endpoint deducts 3 credits from your request bucket.

Scopes

This endpoint is only available for users with scope APP::MISC.

<?php

// Instantiate a GuzzleHttp client
$client = new \GuzzleHttp\Client();

// Make the request
$response = $client->request("GET", "https://public-api.bladepro.io/v1/warehouses?expand=*", [
    "headers" => [
        "Content-Type" => "application/json",
        "Access-Token" => "my-token-from-login",
    ],
]);

// Process the response
$responseBody = json_decode($response->getBody(), true);

require 'rest-client'
require 'json'

# Make the request
response = RestClient.get 'https://public-api.bladepro.io/v1/warehouses?expand=*', {
  access_token: 'my-token-from-login',
  content_type: :json,
  accept: :json
}

# Process the response
puts response.body

// Require the node HTTP module
var request = require("request");

// Make the request
request({
    method: "GET",
    json: true,
    uri: "https://public-api.bladepro.io/v1/warehouses?expand=*",
    headers: {
        "Access-Token": "my-token-from-login",
        "Content-Type": "application/json",
    },
    (error, response, body) => {
        // Process the response
        console.log(body);
    },
});

# Make the request
curl --location --request GET 'https://public-api.bladepro.io/v1/warehouses?expand=*' \
--header 'Content-Type: application/json' \
--header 'Access-Token: my-token-from-login'

Example result:

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

List Carton Label Types

GET /v1/warehouses/carton_label_types

Lists carton label types.

Return Type

array<CartonLabelTypes>

Available expands

Field	Return Type	Description
`carton_label_type_references`	`array<CartonLabelTypeReferences>`	References for carton label types.

Rate limit cost

Each call to this endpoint deducts 1 credit from your request bucket.

Scopes

This endpoint is only available for users with scope APP::ORDERS::READ.

<?php

// Instantiate a GuzzleHttp client
$client = new \GuzzleHttp\Client();

// Make the request
$response = $client->request("GET", "https://public-api.bladepro.io/v1/warehouses/carton_label_types?expand=*", [
    "headers" => [
        "Content-Type" => "application/json",
        "Access-Token" => "my-token-from-login",
    ],
]);

// Process the response
$responseBody = json_decode($response->getBody(), true);

require 'rest-client'
require 'json'

# Make the request
response = RestClient.get 'https://public-api.bladepro.io/v1/warehouses/carton_label_types?expand=*', {
  access_token: 'my-token-from-login',
  content_type: :json,
  accept: :json
}

# Process the response
puts response.body

// Require the node HTTP module
var request = require("request");

// Make the request
request({
    method: "GET",
    json: true,
    uri: "https://public-api.bladepro.io/v1/warehouses/carton_label_types?expand=*",
    headers: {
        "Access-Token": "my-token-from-login",
        "Content-Type": "application/json",
    },
    (error, response, body) => {
        // Process the response
        console.log(body);
    },
});

# Make the request
curl --location --request GET 'https://public-api.bladepro.io/v1/warehouses/carton_label_types?expand=*' \
--header 'Content-Type: application/json' \
--header 'Access-Token: my-token-from-login'

Example result:

{
    "meta": {
        "request_reference": "235chjz9h-c893v86"
    },
    "data": [
        {
            "id": 1,
            "name": "Nordstrom",
            "active": 1,
            "carton_label_type_references": [
                {
                    "name": "Carrier",
                    "code": "CARR",
                    "type": "text",
                    "validation_pattern": "[a-zA-Z0-9_ -]*"
                }
            ]
        }
    ]
}