Skip to main content
The Create Manifest endpoint initializes a new flight manifest container in Shiipp, automatically generating a unique manifest number and recording the creation event in the audit trail. Once created, the manifest starts in draft status and can be populated with packages before being advanced through the dispatch workflow.

Endpoint

POST /api/CreateManifest.php

Authentication

All requests must include a valid JWT Bearer token in the Authorization header. The authenticated user must hold the manifest:create permission, which is granted to the admin, manager, and warehouse roles.
Authorization: Bearer <your_jwt_token>

Request Body

All body parameters are optional. Omitting warehouse_id causes the manifest to be assigned to the tenant’s primary warehouse.
awb_number
string
Air Waybill number for the flight (e.g., 810-12345678). When provided, Shiipp uses the numeric prefix to auto-detect and populate the associated airline.
warehouse_id
string
UUID of the warehouse to associate with this manifest. Defaults to the tenant’s primary warehouse when omitted.
remarks
string
Free-text remarks written to the manifest audit log at creation time. Useful for recording batch notes, shipment context, or operator references.

Example Request

{
  "awb_number": "810-12345678",
  "remarks": "January batch"
}

Response

200 — Success

A manifest was successfully initialized. The response includes the generated manifest_id (used in all subsequent manifest operations) and the human-readable manifest_number.
{
  "status": "success",
  "message": "Manifest created and initialized in audit log",
  "data": {
    "manifest_id": "abc123def456",
    "manifest_number": "MAN-20240115-A3B2",
    "status": "draft"
  }
}
status
string
Always "success" on a successful response.
data
object

Notes

Manifest numbers follow the format MAN-YYYYMMDD-XXXX, where the date component reflects the UTC creation date. The four-character suffix is randomly generated to avoid collisions across bulk-creation workflows.
Every manifest creation event is automatically written to the manifest audit trail. No additional call is needed to initialize the log — the remarks field provides an optional first entry.
All new manifests begin with status: draft. Advance the manifest through the workflow — ready, shipped, completed — using the Manage Manifests endpoint’s update_meta action.