Manage Shiipp Manifests: Status, Packages, Metadata

The Manage Manifests endpoint is the primary mutation surface for the manifest lifecycle in Shiipp. Rather than exposing separate routes for each operation, it uses a single action field to route the request to the appropriate handler — covering everything from manifest creation and metadata updates to package assignment and final deletion. All mutating operations are recorded in the manifest audit trail.

Endpoint

POST /api/ManageManifest.php

Authentication

All requests must include a valid JWT Bearer token in the Authorization header.

Authorization: Bearer <your_jwt_token>

Request Structure

Every request must include an action field that identifies the operation to perform. Additional fields are required or optional depending on the chosen action.

string

required

The operation to execute. One of: create_manifest, update_meta, add_packages, remove_packages, delete_manifest.

Actions

create_manifest
update_meta
add_packages
remove_packages
delete_manifest

Creates a new manifest. This action mirrors the behavior of POST /api/CreateManifest.php and is provided for workflows that prefer a single endpoint.Additional fields:

string

Air Waybill number. Triggers automatic airline prefix detection.

string

Explicit airline prefix override. Ignored when awb_number is provided.

string

Scheduled flight date in YYYY-MM-DD format.

string

Initial notes to store on the manifest record.

string

UUID of the target warehouse. Defaults to the tenant’s primary warehouse.

Response data: manifest_id, manifest_number, status: "draft".

Updates metadata fields and/or the lifecycle status of an existing manifest. Status transitions trigger email notifications and audit log entries.Required fields:

string

required

UUID of the manifest to update.

Optional update fields:

string

New lifecycle status. Valid transitions: draft → ready → shipped → completed. Advancing to ready, shipped, or completed sends email notifications to relevant courier partners.

string

Updated Air Waybill number.

string

Updated airline prefix code.

string

Updated flight date in YYYY-MM-DD format.

string

Airline flight number (e.g., AA123).

string

Updated notes to store on the manifest record.

string

Remarks to append to the audit log entry for this update.

Permanently deletes a manifest record. The manifest must have no packages attached before deletion is permitted.

string

required

UUID of the manifest to delete.

Deletion is permanent and cannot be undone. Use remove_packages to detach all packages before calling this action. Attempting to delete a manifest that still has packages returns a 400 error.

Example Request — Change Status to Shipped

{
  "action": "update_meta",
  "manifest_id": "abc123def456",
  "status": "shipped",
  "remarks": "Flight AA123 departed on schedule"
}

curl -X POST https://app.shiipp.com/api/ManageManifest.php \
  -H "Authorization: Bearer <your_jwt_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "update_meta",
    "manifest_id": "abc123def456",
    "status": "shipped",
    "remarks": "Flight AA123 departed on schedule"
  }'

Success Response

{
  "status": "success",
  "message": "Manifest operation completed successfully",
  "timestamp": "2024-01-20 14:35:00"
}

Error Responses

HTTP Code	Cause
`400`	`manifest_id` is missing or the `action` value is not recognized
`400`	Attempting to delete a manifest that still has packages attached
`401`	Missing or invalid JWT token
`404`	No manifest found for the provided `manifest_id`

Email notifications to courier partners are dispatched after the database transaction commits successfully. Delivery failures are logged in Shiipp’s internal notification log but do not affect the API response — a 200 is returned regardless of email delivery outcome.

Use the remarks field on any update_meta call to leave a human-readable note in the audit trail. This is especially useful when advancing status to shipped or completed to capture flight details or operator sign-off notes.

Overview

Prealerts

Packages

Customers

Manifests

Billing

Courier Settings

Manage Shiipp Manifests: Status, Packages, Metadata

Endpoint

Authentication

Request Structure

Actions

Example Request — Change Status to Shipped

Success Response

Error Responses

​Endpoint

​Authentication

​Request Structure

​Actions

​Example Request — Change Status to Shipped

​Success Response

​Error Responses

Endpoint

Authentication

Request Structure

Actions

Example Request — Change Status to Shipped

Success Response

Error Responses