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"

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

data.info

object

Manifest-level metadata.

Show info fields

manifest_id

string

The unique UUID of the manifest.

manifest_number

string

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

awb_number

string

Air Waybill number associated with the flight, if set.

airline_prefix

string

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

flight_date

string

Scheduled flight date in YYYY-MM-DD format.

status

string

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

notes

string

Free-text notes stored on the manifest record.

created_at

string

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

data.packages

array

Array of package objects linked to this manifest.

Show package fields

package_id

string

Unique UUID of the package.

tracking_number

string

Carrier-assigned tracking number for the package.

house_number

string

Internal house airway bill number assigned by Shiipp.

weight

number

Package weight in pounds.

first_name

string

Recipient’s first name.

last_name

string

Recipient’s last name.

user_code

string

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

courier_name

string

Display name of the courier service that owns this package.

courier_code

string

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

carrier_name

string

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

data.stats

object

Aggregate statistics computed across all linked packages.

Show stats fields

total_count

integer

Total number of packages on the manifest.

total_weight_lb

number

Combined weight of all packages in pounds.

total_weight_kg

number

Combined weight of all packages in kilograms.

by_courier

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`

​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