Warehouses

Manage warehouse locations and inventory distribution points across your e-commerce network. Warehouses control product availability, stock levels, and fulfillment locations for orders.

Basic CRUD Actions

Get Warehouses listing

View on Postman

Get a list of all warehouses.

JavaScript

let warehouses = await Client.API.Core.Warehouses.all();

TypeScript

import { Response, Warehouses } from "@tscommerce/sdk-typescript"

Client.API.Core.Warehouses.all().then((response:Response<Warehouses>) => {
    response.resource.forEach((warehouse) => {
        console.log(warehouse.id);
    });
});

PHP

$warehouses = $client->API->Core->Warehouses->all();

Create new Warehouse

View on Postman

Create a brand new warehouse.

JavaScript

const payload = {
    // Add fields here
};
let warehouse = await Client.API.Core.Warehouses.create(payload);

TypeScript

import { Response, Warehouse, CreateWarehousePayload } from "@tscommerce/sdk-typescript"

const payload:CreateWarehousePayload = {
    // Add fields here
};

Client.API.Core.Warehouses.create(payload).then((response:Response<Warehouse>) => {
    console.log('Created:', response.resource);
});

PHP

$payload = [
    // Add fields here
];
$warehouse = $client->API->Core->Warehouses->create($payload);

Get Warehouse

View on Postman

Get an existing warehouse by ID.

JavaScript

const warehouseId = 123;
let warehouse = await Client.API.Core.Warehouses.read(warehouseId);

TypeScript

import { Response, Warehouse } from "@tscommerce/sdk-typescript"

const warehouseId:Warehouse['id'] = 123;
Client.API.Core.Warehouses.read(warehouseId).then((response:Response<Warehouse>) => {
    console.log(response.resource);
});

PHP

$warehouseId = 123;
$warehouse = $client->API->Core->Warehouses->read($warehouseId);

Update Warehouse

View on Postman

Update an existing warehouse.

JavaScript

const warehouseId = 123;
const payload = {
    // Updated fields
};
let warehouse = await Client.API.Core.Warehouses.update(warehouseId, payload);

TypeScript

import { Response, Warehouse, UpdateWarehousePayload } from "@tscommerce/sdk-typescript"

const warehouseId:Warehouse['id'] = 123;
const payload:UpdateWarehousePayload = {
    // Updated fields
};

Client.API.Core.Warehouses.update(warehouseId, payload).then((response:Response<Warehouse>) => {
    console.log('Updated:', response.resource);
});

PHP

$warehouseId = 123;
$payload = [
    // Updated fields
];
$warehouse = $client->API->Core->Warehouses->update($warehouseId, $payload);

Delete Warehouse

View on Postman

Delete an existing warehouse.

JavaScript

const warehouseId = 123;
Client.API.Core.Warehouses.delete(warehouseId);

TypeScript

import { Response, Warehouse } from "@tscommerce/sdk-typescript"

const warehouseId:Warehouse['id'] = 123;
Client.API.Core.Warehouses.delete(warehouseId).then((response:Response) => {
    console.log('Deleted successfully');
});

PHP

$warehouseId = 123;
$client->API->Core->Warehouses->delete($warehouseId);

Duplication

Duplicate Warehouse

View on Postman

Create a duplicate of an existing warehouse.

JavaScript

const warehouseId = 123;
let duplicated = await Client.API.Core.Warehouses.duplicate(warehouseId);

TypeScript

import { Response, Warehouse } from "@tscommerce/sdk-typescript"

const warehouseId:Warehouse['id'] = 123;
Client.API.Core.Warehouses.duplicate(warehouseId).then((response:Response<Warehouse>) => {
    console.log('Duplicated warehouse:', response.resource);
});

PHP

$warehouseId = 123;
$duplicated = $client->API->Core->Warehouses->duplicate($warehouseId);

Bulk Actions

Bulk delete Warehouses

View on Postman

Delete multiple warehouses at once.

JavaScript

const warehouseIds = [123, 456, 789];
Client.API.Core.Warehouses.bulkDelete(warehouseIds);

TypeScript

import { Response, Warehouse } from "@tscommerce/sdk-typescript"

const warehouseIds:Array<Warehouse['id']> = [123, 456, 789];
Client.API.Core.Warehouses.bulkDelete(warehouseIds).then((response:Response) => {
    console.log('Warehouses deleted successfully');
});

PHP

$warehouseIds = [123, 456, 789];
$client->API->Core->Warehouses->bulkDelete($warehouseIds);

Warehouse Inventory

Get Warehouse Products

View on Postman

Get all products available in a specific warehouse.

JavaScript

const warehouseId = 123;
let products = await Client.API.Core.Warehouses.getProducts(warehouseId);

TypeScript

import { Response, Warehouse } from "@tscommerce/sdk-typescript"

const warehouseId:Warehouse['id'] = 123;
Client.API.Core.Warehouses.getProducts(warehouseId).then((response:Response) => {
    console.log('Warehouse products:', response.resource);
});

PHP

$warehouseId = 123;
$products = $client->API->Core->Warehouses->getProducts($warehouseId);

Assign Product Quantity

View on Postman

Assign or update product quantity in a warehouse.

JavaScript

const warehouseId = 123;
const productId = 456;
const quantity = 100;
Client.API.Core.Warehouses.assignQuantity(warehouseId, productId, quantity);

TypeScript

import { Response, Warehouse } from "@tscommerce/sdk-typescript"

const warehouseId:Warehouse['id'] = 123;
const productId:number = 456;
const quantity:number = 100;

Client.API.Core.Warehouses.assignQuantity(warehouseId, productId, quantity).then((response:Response) => {
    console.log('Quantity assigned successfully');
});

PHP

$warehouseId = 123;
$productId = 456;
$quantity = 100;
$client->API->Core->Warehouses->assignQuantity($warehouseId, $productId, $quantity);