Skip to content
/SCAN Form

Create USPS SCAN Form

Request

Creates a USPS SCAN Form (PS Form 5630) for a set of already-purchased shipments and returns the URL of the generated manifest PDF. A SCAN Form is a single manifest barcode that consolidates multiple shipments so the carrier can accept the whole batch with one scan at drop-off.

Security
BearerAuth
Bodyapplication/jsonrequired
address_dataobject(ScanFormAddress)required

Shipped from address printed on the SCAN Form. At least one of company_name or the first_name + last_name pair must be provided.

tracking_nosArray of strings, non-emptyrequired

Tracking numbers of the purchased shipments to include in the SCAN Form. Every shipment must belong to USPS and be in a purchased, not-yet-shipped state; a shipment may appear on only one SCAN Form.

ship_datestring, (date)

A calendar date in ISO 8601 full-date format (YYYY-MM-DD), without time or time zone. Optional; defaults to the current date if omitted.

Example:"2026-07-21"
POST
/api/scan_form/create_scan_form
curl -i -X POST \
  https://x-api.shipsaving.com/api/scan_form/create_scan_form \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "address_data": {
      "company_name": "ShipSaving",
      "first_name": "Alice",
      "last_name": "Green",
      "phone": "1234567890",
      "email": "it@shipsaving.com",
      "street": "xxxx Olive Street",
      "street2": "STE XXX",
      "city": "Los Angeles",
      "state": "CA",
      "zip_code": "021XX",
      "country": "US"
    },
    "tracking_nos": [
      "9234690381085700XXXXX"
    ],
    "ship_date": "2026-07-21"
  }'

Responses

OK

Bodyapplication/json
codestring

Result code. ok indicates success; any other value indicates a business error and data is null.

Example:"ok"
msgstring

Human-readable result message.

Example:"ok"
dataobject(ScanFormCreateResponse)

Response payload; null when code is not ok.

Response
{
  "code": "ok",
  "msg": "ok",
  "data": {
    "scan_form_image": "https://xxxxx/forms/2026-07-16/92XXXXXXXXX00000010794.pdf"
  }
}