Tracepos Developer HubTracepos Developer Hub
Home
Guide
POS & Integrations
API Reference
Webhooks
Postman Collection
Home
Guide
POS & Integrations
API Reference
Webhooks
Postman Collection
  • Overview & Specifications

    • Tracepos Public API Reference
  • Core Catalog & Outlets

    • Products API
    • Categories & Brands API
    • Warehouses & Outlets API
  • Parties & CRM

    • Customers & Suppliers API
  • Operations & Stock

    • Sales & Transactions API
    • Purchases & Procurement API
    • Inventory & Price Adjustments API
    • Returns & Reversals API
  • Financial Ledger & Expenses

    • Payments & Settlements API
    • Expense Management API
    • Double-Entry Accounting Architecture
  • Real-Time Sync

    • Webhooks & Real-Time Sync

Warehouses & Outlets API

In Tracepos, a Warehouse represents an individual physical branch, retail store outlet, or fulfillment depot. Every API key pair is cryptographically bound to a specific warehouse ID, scoping inventory levels, customer visibility, cash drawers, and journal ledgers.

The Warehouses API enables multi-location chains, franchise operations, and store directory pickers to query branch networks, verify operating outlets, and inspect POS hardware configurations.


1. List All Warehouses (Branches)

Retrieve all active warehouses belonging to the company of the authenticated API key. Useful for mobile POS apps, customer checkout branch switchers, or omnichannel "Click & Collect" selectors.

GET/api/v1/public/warehousesScope: read

Headers

HeaderTypeRequiredDescription
X-Tracepos-Public-KeyStringYesWarehouse public API key
X-Tracepos-Secret-KeyStringYesWarehouse secret API key
AcceptStringYesapplication/json

Code Samples

cURL
curl -X GET "https://app.tracepos.net/api/v1/public/warehouses" \
  -H "X-Tracepos-Public-Key: YOUR_PUBLIC_KEY" \
  -H "X-Tracepos-Secret-Key: YOUR_SECRET_KEY" \
  -H "Accept: application/json"
Node.js (Axios)
const axios = require('axios');

async function getWarehouses() {
  const response = await axios.get('https://app.tracepos.net/api/v1/public/warehouses', {
    headers: {
      'X-Tracepos-Public-Key': process.env.TRACEPOS_PUBLIC_KEY,
      'X-Tracepos-Secret-Key': process.env.TRACEPOS_SECRET_KEY,
      'Accept': 'application/json',
    },
  });

  return response.data.data;
}
Python (Requests)
import os
import requests

headers = {
    "X-Tracepos-Public-Key": os.getenv("TRACEPOS_PUBLIC_KEY"),
    "X-Tracepos-Secret-Key": os.getenv("TRACEPOS_SECRET_KEY"),
    "Accept": "application/json",
}

response = requests.get("https://app.tracepos.net/api/v1/public/warehouses", headers=headers)
warehouses = response.json().get("data", [])
PHP (Guzzle)
<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client(['base_uri' => 'https://app.tracepos.net/api/v1/public/']);

$response = $client->get('warehouses', [
    'headers' => [
        'X-Tracepos-Public-Key' => getenv('TRACEPOS_PUBLIC_KEY'),
        'X-Tracepos-Secret-Key' => getenv('TRACEPOS_SECRET_KEY'),
        'Accept'                => 'application/json',
    ],
]);

$warehouses = json_decode($response->getBody()->getContents(), true)['data'];

Response (200 OK)

{
  "status": "success",
  "data": [
    {
      "id": 1,
      "name": "Victoria Island Flagship Outlet",
      "slug": "vi-flagship",
      "email": "[email protected]",
      "phone": "+2348012345678",
      "address": "Plot 1412 Adeola Hopewell St",
      "city": "Lagos",
      "country": "Nigeria",
      "zipcode": "101241",
      "logo": "https://app.tracepos.net/uploads/outlets/vi-logo.png",
      "dark_logo": "https://app.tracepos.net/uploads/outlets/vi-logo-dark.png",
      "online_store_enabled": 1
    },
    {
      "id": 2,
      "name": "Ikeja GRA Supercenter",
      "slug": "ikeja-gra",
      "email": "[email protected]",
      "phone": "+2348098765432",
      "address": "28 Isaac John Street",
      "city": "Lagos",
      "country": "Nigeria",
      "zipcode": "100271",
      "logo": "https://app.tracepos.net/uploads/outlets/ikeja-logo.png",
      "dark_logo": "https://app.tracepos.net/uploads/outlets/ikeja-logo-dark.png",
      "online_store_enabled": 1
    }
  ]
}

2. Get Single Warehouse Details

Retrieve detailed metadata and configuration flags for a specific warehouse outlet within your company.

GET/api/v1/public/warehouses/{warehouse-xid}Scope: read

Path Parameters

ParameterTypeRequiredDescription
warehouse-xidString / IntegerYesWarehouse Hash ID (xid). Positive numeric IDs are supported for backward compatibility.

Response (200 OK)

{
  "status": "success",
  "data": {
    "id": 1,
    "company_id": 4,
    "name": "Victoria Island Flagship Outlet",
    "slug": "vi-flagship",
    "email": "[email protected]",
    "phone": "+2348012345678",
    "address": "Plot 1412 Adeola Hopewell St",
    "city": "Lagos",
    "country": "Nigeria",
    "zipcode": "101241",
    "barcode_type": "CODE128",
    "default_pos_order_status": "delivered",
    "customers_visibility": "all",
    "suppliers_visibility": "all",
    "online_store_enabled": 1
  }
}
Prev
Categories & Brands API