Partner Integration

Shiplah Open API

Use the Open API to list visible delivery jobs and update them by Marking Number. API access is scoped to the organization that owns the API key.

Before You Start

To use the API or webhooks, first request a Shiplah Track account for your agent or contractor organization. Send the login email address, organization name, and account type (Agent or Contractor) to yw@shiplah.sg, or contact us on WhatsApp at +65 8060 8787. After manual review, Shiplah will send a registration email. Complete registration, sign in to Shiplah Track, then open Integrations to configure your API key, webhook URL, and related parameters.

Authentication

Send your API key with every request.

x-api-key: shiplah_live_xxx

Job Identity

Use the Marking Number to find and update delivery jobs.

Webhook

Receive JSON events when visible delivery jobs change status.

Base URL

https://www.shiplahsg.com/api/v1/open-api

Quick Start

curl -H "x-api-key: shiplah_live_xxx" \
  "https://www.shiplahsg.com/api/v1/open-api/jobs?marking_number=MARK-001"

Response Envelope

Every successful response uses the same envelope.

{
  "request_id": "req_...",
  "success": true,
  "data": {},
  "error": null
}

Available Endpoints

Method	Endpoint	Purpose
GET	`/jobs`	List visible delivery jobs.
PATCH	`/jobs/by-marking/:markingNumber`	Update one delivery job by Marking Number.
PATCH	`/jobs/batch`	Update up to 100 delivery jobs by Marking Number.