Partner Integration

Shiplah Open API

This documentation covers the first public partner API for delivery jobs: list jobs, update one job by Batch Number, and batch update jobs.

Authentication

Generate an API key from the Shiplah integrations page and send it with each request.

x-api-key: shiplah_live_xxx

Job Identity

Batch Number maps to the first available value from job number, import batch number, or provider job id.

Webhook

Configure an endpoint to receive JSON events when visible jobs are created, updated, or change status.

Base URL

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

Response Envelope

All API responses use the standard Shiplah envelope.

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