Get Shiipp Manifest Details, Statistics, and Packages

The Get Manifest endpoint returns a complete snapshot of a flight manifest: its metadata (AWB number, flight date, current status), every package linked to it, and pre-computed aggregate statistics broken down by weight and courier. This single call is designed to power both the manifest detail view and the pre-flight package checklist.

Endpoint

GET /api/GetManifest.php

Authentication

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

Authorization: Bearer <your_jwt_token>

Query Parameters

string

required

The UUID of the manifest to retrieve. This is the manifest_id returned by Create Manifest or Manage Manifests.

Example Request

curl -G https://app.shiipp.com/api/GetManifest.php \
  -H "Authorization: Bearer <your_jwt_token>" \
  --data-urlencode "id=abc123def456"

GET /api/GetManifest.php?id=abc123def456

Response

200 — Success

The response is structured into three top-level sections under data: info (manifest metadata), packages (the full package list), and stats (aggregate totals and per-courier breakdowns).

{
  "status": "success",
  "data": {
    "info": {
      "manifest_id": "abc123def456",
      "manifest_number": "MAN-20240115-A3B2",
      "awb_number": "810-12345678",
      "airline_prefix": "810",
      "flight_date": "2024-01-20",
      "status": "draft",
      "notes": "January batch",
      "created_at": "2024-01-15 09:00:00"
    },
    "packages": [
      {
        "package_id": "pkg-uuid",
        "tracking_number": "1Z9999999999999999",
        "house_number": "HN-00142",
        "weight": 3.5,
        "first_name": "Jane",
        "last_name": "Smith",
        "user_code": "CUST001",
        "courier_name": "Express Couriers",
        "courier_code": "EXP",
        "carrier_name": "UPS"
      }
    ],
    "stats": {
      "total_count": 28,
      "total_weight_lb": 97.4,
      "total_weight_kg": 44.18,
      "by_courier": {
        "EXP": { "count": 18, "weight": 62.1, "house_color": "#065ea1" },
        "ACE": { "count": 10, "weight": 35.3, "house_color": "#e85d04" }
      }
    }
  }
}

Response Fields

object

Manifest-level metadata.

Show info fields

string

The unique UUID of the manifest.

string

Human-readable manifest identifier in MAN-YYYYMMDD-XXXX format.

string

Air Waybill number associated with the flight, if set.

string

Numeric prefix extracted from the AWB number, used for airline lookup.

string

Scheduled flight date in YYYY-MM-DD format.

string

Current lifecycle status: draft, ready, shipped, or completed.

string

Free-text notes stored on the manifest record.

string

UTC timestamp of manifest creation in YYYY-MM-DD HH:MM:SS format.

array

Array of package objects linked to this manifest.

Show package fields

string

Unique UUID of the package.

string

Carrier-assigned tracking number for the package.

string

Internal house airway bill number assigned by Shiipp.

number

Package weight in pounds.

string

Recipient’s first name.

string

Recipient’s last name.

string

The customer’s mailbox or account code within the courier’s tenant.

string

Display name of the courier service that owns this package.

string

Short alphanumeric code identifying the courier (e.g., EXP).

string

The physical carrier (e.g., UPS, FedEx) that delivered the package to the warehouse.

object

Aggregate statistics computed across all linked packages.

Show stats fields

integer

Total number of packages on the manifest.

number

Combined weight of all packages in pounds.

number

Combined weight of all packages in kilograms.

object

Per-courier breakdown keyed by courier_code. Each entry contains count (integer), weight (number, pounds), and house_color (hex string used for manifest color-coding in the UI).

Error Responses

HTTP Code	Cause
`400`	`id` query parameter is missing
`401`	Missing or invalid JWT token
`404`	No manifest found for the given `id`

Overview

Prealerts

Packages

Customers

Manifests

Billing

Courier Settings

Get Shiipp Manifest Details, Statistics, and Packages

Endpoint

Authentication

Query Parameters

Example Request

Response

200 — Success

Response Fields

Error Responses

​Endpoint

​Authentication

​Query Parameters

​Example Request

​Response

​200 — Success

​Response Fields

​Error Responses

Endpoint

Authentication

Query Parameters

Example Request

Response

200 — Success

Response Fields

Error Responses