Theme

Hubs API ​

API endpoints for Hubs operations in LSP.

Endpoints ​

API Reference ​

Create a hub ​

http
POST /v1/lsp/hubs/create

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Request Body ​

typescript
interface Create a hubRequest {
  type: string;
  code: string;
  name: string;
  description: string;
  contacts: {
    emails: string[];
    phones: string[]
  };
  address: {
    name: string;
    street1: string;
    city: string;
    state: string;
    country: string;
    coordinates: number[]
  };
  timezone: string;
  level: string;
  operatingMode: string;
  operatingHours: {
    dayOfWeek: string;
    openTime: string;
    closeTime: string;
    isClosed: boolean
  }[];
  digitalTwinSync: boolean;
}

Example:

json
{
  "type": "DISTRIBUTION",
  "code": "1B-O",
  "name": "Pillar Hub",
  "description": "Transit hub from Greater Accra to the Ashanti region",
  "contacts": {
    "emails": [
      "[email protected]"
    ],
    "phones": [
      "+1 898 938 382 422",
      "+233 204 55323"
    ]
  },
  "address": {
    "name": "Flask House",
    "street1": "Aymensah Road, Peduasè",
    "city": "Accra",
    "state": "Greater Accra",
    "country": "Ghana",
    "coordinates": [
      -0.1387423,
      5.1284859
    ]
  },
  "timezone": "Africa/Accra",
  "level": "STANDARD",
  "operatingMode": "24_7",
  "operatingHours": [
    {
      "dayOfWeek": "MONDAY",
      "openTime": "07:00",
      "closeTime": "19:00",
      "isClosed": false
    },
    {
      "dayOfWeek": "TUESDAY",
      "openTime": "07:00",
      "closeTime": "19:00",
      "isClosed": false
    },
    {
      "dayOfWeek": "WEDNESDAY",
      "openTime": "07:00",
      "closeTime": "19:00",
      "isClosed": false
    },
    {
      "dayOfWeek": "THURSDAY",
      "openTime": "07:00",
      "closeTime": "19:00",
      "isClosed": false
    },
    {
      "dayOfWeek": "FRIDAY",
      "openTime": "07:00",
      "closeTime": "19:00",
      "isClosed": false
    },
    {
      "dayOfWeek": "SATURDAY",
      "openTime": "08:00",
      "closeTime": "16:00",
      "isClosed": false
    },
    {
      "dayOfWeek": "SUNDAY",
      "openTime": "00:00",
      "closeTime": "00:00",
      "isClosed": true
    }
  ],
  "digitalTwinSync": true
}

Get Hub profile ​

http
GET /v1/lsp/hubs/:id

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Get all hubs ​

http
GET /v1/lsp/hubs

Update hub profile ​

http
PATCH /v1/lsp/hubs/:id

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Delete hub ​

http
DELETE /v1/lsp/hubs/:id

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Add/Remove pricing to/from a hub ​

http
PUT /v1/lsp/hubs/:id/pricing/:action

Headers ​

  • X-User-Agent (required)
  • X-Auth-Token (required)
  • X-Auth-Device (required)