Theme

Integrations ​

API endpoints for Integrations management in WORKSPACE.

Search agents arround ​

http
POST /v1/client/:id/periferals

Headers ​

  • origin (required)

Get orders ​

http
GET /v1/client/:id/orders/:type

Headers ​

  • origin (required)

Get order intent token ​

http
POST /v1/order/intent

Headers ​

  • origin (required)

Cancel order intent ​

http
DELETE /v1/order/intent/cancel

Headers ​

  • Origin (required)
  • x-intent-token (required)

Get order operators information ​

http
GET /v1/order/operators

Headers ​

  • origin (required)
  • x-intent-token (required)

Add waypoints to order ​

http
PUT /v1/order/waypoints/add

Headers ​

  • origin (required)
  • x-intent-token (required)

Request Body ​

typescript
interface Add waypoints to orderRequest {
  0: {
    no: number;
    type: string;
    description: string;
    coordinates: number[];
    address: string;
    contact: {
    type: string;
    reference: string;
    phone: string;
    email: string
  }
  };
  1: {
    no: number;
    type: string;
    description: string;
    coordinates: number[];
    address: string;
    contact: {
    type: string;
    reference: string;
    phone: string;
    email: string
  }
  };
}

Example:

json
[
  {
    "no": 1,
    "type": "pickup",
    "description": "",
    "coordinates": [
      1.2233,
      5.4433
    ],
    "address": "Legon university, Accra - Ghana",
    "contact": {
      "type": "restaurant",
      "reference": "{{$guid}}",
      "phone": "+2330245558888",
      "email": "[email protected]"
    }
  },
  {
    "no": 2,
    "type": "dropoff",
    "description": "",
    "coordinates": [
      1.223,
      5.4405
    ],
    "address": "Madina market, Accra - Ghana",
    "contact": {
      "type": "client",
      "reference": "{{$guid}}",
      "phone": "+2330200007777",
      "email": "[email protected]"
    }
  }
]

Update waypoint details ​

http
PATCH /v1/order/waypoints/:no

Headers ​

  • origin (required)
  • x-intent-token (required)

Get waypoint details ​

http
GET /v1/order/waypoints/:no

Headers ​

  • origin (required)
  • x-intent-token (required)

Get all waypoints of an order ​

http
GET /v1/order/waypoints

Headers ​

  • origin (required)
  • x-intent-token (required)

Remove waypoint of an order ​

http
DELETE /v1/order/waypoints/:no

Headers ​

  • origin (required)
  • x-intent-token (required)

Add packages to order ​

http
PUT /v1/order/packages/add

Headers ​

  • origin (required)
  • x-intent-token (required)

Request Body ​

typescript
interface Add packages to orderRequest {
  0: {
    waypointNo: number;
    careLevel: number;
    category: string;
    weight: number;
    note: string
  };
}

Example:

json
[
  {
    "waypointNo": 1,
    "careLevel": 3,
    "category": "FD",
    "weight": 0.25,
    "note": "Wrap well"
  }
]

Update pckage details ​

http
PATCH /v1/order/packages/:PTC

Headers ​

  • origin (required)
  • x-intent-token (required)

Get package details ​

http
GET /v1/order/packages/:PTC

Headers ​

  • origin (required)
  • x-intent-token (required)

Get all packages of an order ​

http
GET /v1/order/packages

Headers ​

  • origin (required)
  • x-intent-token (required)

Remove package of an order ​

http
DELETE /v1/order/packages/:PTC

Headers ​

  • origin (required)
  • x-intent-token (required)

Initiate service ​

http
POST /v1/order/service

Headers ​

  • origin (required)
  • x-intent-token (required)

Request Body ​

typescript
interface Initiate serviceRequest {
  fees: {
    total: {
    amount: number;
    currency: string
  };
    tax: number;
    discount: number
  };
  payment: {
    mode: string;
    paid: boolean
  };
  xpress: string;
}

Example:

json
{
  "fees": {
    "total": {
      "amount": 12,
      "currency": "GHS"
    },
    "tax": 0.015,
    "discount": 0.2
  },
  "payment": {
    "mode": "cash",
    "paid": false
  },
  "xpress": "standard"
}

Update service details ​

http
PATCH /v1/order/service

Headers ​

  • origin (required)
  • x-intent-token (required)

Get service details ​

http
GET /v1/order/service

Headers ​

  • origin (required)
  • x-intent-token (required)

Rate the service ​

http
POST /v1/order/service/rating

Headers ​

  • origin (required)
  • x-intent-token (required)

Get order route ​

http
GET /v1/order/route

Headers ​

  • origin (required)
  • x-intent-token (required)

Get order current stage & status ​

http
GET /v1/order/stage

Headers ​

  • origin (required)
  • x-intent-token (required)