API Reference

Warehouses

Manage and query warehouse information including locations and zones.

⚠️ Important: Timezone and Date Handling

The warehouse timezoneId field is critical for interpreting date/time values in API responses. Most date fields throughout the API (e.g., dateEntered, expectedDispatchDateTime) are returned in the warehouse's local timezone, not UTC, despite having a Z suffix. See Date and Time Formats for full details.

Endpoints Overview

Method Endpoint Description
GET /v1/warehouses Get a page of warehouses
GET /v1/warehouses/{warehouseId} Get warehouse details

Get Warehouses Page

Retrieve a paginated list of warehouses.

Endpoint: GET /v1/warehouses

Query Parameters

Parameter Type Required Description
PageIndex integer No Page number (default: 0)
PageSize integer No Items per page (default: 25, max: 500)
SearchText string No Filter by warehouse name
Status integer No Filter by warehouse status

Warehouse Status Values

Value Status Description
1 Active Active warehouse
2 Inactive Inactive warehouse

Request Example 

curl -X GET "https://api.consignlyhq.com/v1/warehouses?PageIndex=0&PageSize=25&Status=1" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Response Example 

{
  "index": 0,
  "total": 5,
  "warehouses": [
    {
      "id": "550e8400-e29b-41d4-a716-446655444000",
      "name": "Auckland Main Warehouse",
      "code": "WH01",
      "status": 1,
      "addressId": "550e8400-e29b-41d4-a716-446655444010",
      "latitude": -36.9082,
      "longitude": 174.8086,
      "timezoneId": "Pacific/Auckland"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655444001",
      "name": "Wellington Distribution Centre",
      "code": "WH02",
      "status": 1,
      "addressId": "550e8400-e29b-41d4-a716-446655444011",
      "latitude": -41.2865,
      "longitude": 174.7762,
      "timezoneId": "Pacific/Auckland"
    }
  ]
}

Response Fields

Field Type Description
id uuid Warehouse ID
name string Warehouse name
code string Warehouse code
status integer Warehouse status
addressId uuid Address ID
latitude number Warehouse address latitude
longitude number Warehouse address longitude
timezoneId string Warehouse timezone identifier (IANA format)

Get Warehouse Details

Retrieve detailed information for a specific warehouse.

Endpoint: GET /v1/warehouses/{warehouseId}

Path Parameters

Parameter Type Required Description
warehouseId uuid Yes The warehouse ID

Request Example 

curl -X GET "https://api.consignlyhq.com/v1/warehouses/550e8400-e29b-41d4-a716-446655444000" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Response Example 

{
  "id": "550e8400-e29b-41d4-a716-446655444000",
  "name": "Auckland Main Warehouse",
  "code": "WH01",
  "mainPhone": "+64 9 555 1234",
  "contactPerson": "John Smith",
  "contactPhone": "+64 21 555 1234",
  "address": {
    "name": "Auckland Main Warehouse",
    "code": "WH01",
    "phone": "+64 9 555 1234",
    "streetAddress": "123 Industrial Avenue",
    "suburb": "Penrose",
    "city": "Auckland",
    "state": "Auckland",
    "postCode": "1061",
    "country": "New Zealand",
    "latitude": -36.9082,
    "longitude": 174.8086
  },
  "costCentre": {
    "id": "550e8400-e29b-41d4-a716-446655449850",
    "name": "Auckland Warehouse",
    "code": "CC-WH01"
  },
  "revenueAccount": {
    "id": "550e8400-e29b-41d4-a716-446655449300",
    "name": "Sales - Storage",
    "code": "4000"
  },
  "defaultFafProfile": {
    "id": "550e8400-e29b-41d4-a716-446655449600",
    "name": "Auckland Default FAF",
    "status": 1
  }
}

Detail Response Fields

Field Type Description
id uuid Warehouse ID
name string Warehouse name
code string Warehouse code
mainPhone string Primary phone number
contactPerson string Primary contact name
contactPhone string Primary contact phone number
address object Warehouse address summary (see Address Fields below)
costCentre object Cost centre summary (id, name, code)
revenueAccount object Revenue account summary (id, name, code)
defaultFafProfile object Default FAF profile for the warehouse, or null if not configured

Address Fields

Field Type Description
name string Address name
code string Address code
phone string Phone number
streetAddress string Street address
suburb string Suburb
city string City
state string State
postCode string Postal code
country string Country
latitude number Latitude
longitude number Longitude

Default FAF Profile Fields

Field Type Description
id uuid FAF profile ID
name string FAF profile name
status integer FAF profile status code

Related Endpoints

Previous
Tax Rates
Next
Webhook Subscriptions