Warehouses

Warehouses represent your pickup and return locations. You need at least one warehouse before creating orders.

Imports

import {
  BigshipClient,
  isSuccessResponse,
} from '@agamya/bigship-sdk';

Save Warehouse — saveWarehouse

Register a new warehouse for shipment pickups.

const warehouse = await client.saveWarehouse({
  warehouseName: 'Mumbai Warehouse',
  warehouseContactPerson: 'Amit Kumar',
  warehouseAddressPhone: '9876543210',
  warehouseCountry: 'India',
  warehouseState: 'Maharashtra',
  warehouseCity: 'Mumbai',
  warehousePinCode: '400069',
  warehouseAddressLine1: '12 Industrial Area Phase 2',
  warehouseAddressLine2: 'Andheri East',
  warehouseAddressLandMark: '',
});

if (isSuccessResponse(warehouse)) {
  console.log('Warehouse ID:', warehouse.data);
}

List Warehouses — getWarehouseList

Retrieve your warehouses with pagination.

const warehouses = await client.getWarehouseList({ page: 1, size: 10 });
if (isSuccessResponse(warehouses) && warehouses.data) {
  for (const w of warehouses.data.warehouse) {
    console.log(`ID: ${w.warehouseId} — ${w.warehouseName}`);
  }
}

Pagination Parameters

Parameter	Type	Description
page	number	Page number (1-indexed)
size	number	Number of results per page
filter_type	`‘warehouse_name’	‘warehouse_phone’
filter_value	string	Filter value

Using Warehouses in Orders

The MasterOrderPickUpLocation and MasterOrderReturnLocation in order payloads correspond to warehouse IDs returned by saveWarehouse or getWarehouseList.

const order = await client.createOrder({
  // ...
  MasterOrderPickUpLocation: 123456,  // from saveWarehouse or getWarehouseList
  MasterOrderReturnLocation: 123456,
  // ...
});