Integration Specifications

US Customs Rest API Contract

Mockup schema defining the exact JSON payload Pega must orchestrate to trigger the modernized legacy mainframe business logic.

POST
/api/v1/us-customs/manifest/submit
Submits a consolidated JSON payload containing Waybill, Equipment, and Routing data from the Pega Clipboard. The backend dynamically routes this through GCX111 Orchestration, evaluating all sub-validations (GCX111A/B/C) and Bonds (GCCBOND) before generating the outbound EDI message.

📋 Field-Level Validations Dictionary

The following constraints are actively enforced by the target API gateway. Failure to comply will result in a 400 Bad Request error preventing CBP transmission.

JSON Field / Path Constraint / Extracted COBOL Rule
actionCode
System must reject if Action Code is missing or invalid. Allowed: CREATE, UPDATE, DELETE.
Derived COBOL Constraint
manifest.cargoControlNumber
Validate M1206 Bond Control Number: The bond control number is confirmed as valid customs format or marked as invalid
Derived COBOL Constraint
manifest.commodityList.weight
Validate Numeric Format: The system should verify that weight values contain only valid numeric characters and decimal points
Derived COBOL Constraint
manifest.equipmentContext.equipmentNumber
Equipment Number Numeric?: Equipment processing continues with original equipment ID without check digit removal
Derived COBOL Constraint
manifest.estimatedArrivalDate
Valid Country Codes?: Country codes are confirmed as valid if both origin and destination countries are recognized international trading partners
Derived COBOL Constraint
manifest.isBonded
Bond Information Complete?: If M1202 entry number or M1209 reference number exist, bond information is complete
Derived COBOL Constraint
manifest.portOfArrival
Validate Border Crossing Port Against SE Table: The ports are validated against the SE table to ensure they are valid border crossings
Derived COBOL Constraint
manifest.scacCode
Validate SCAC Code Format: The SCAC code format is verified as valid or invalid according to business standards
Derived COBOL Constraint
manifest.shipper
HN Segment Found?: The system determines if shipper data is available and routes processing accordingly
Derived COBOL Constraint

💻 Pega Clipboard Request Payload (JSON)

This schema dynamically maps internal Pega clipboard structures into the outbound required architecture. The wrapper object contains metadata while the `manifest` object triggers the legacy US Customs parsing logic. 

{
  "//": "Root Pega Submission Envelope"
  "transactionId": "PEG-9823749823",
  "actionCode": "CREATE", "// Enum: CREATE, UPDATE, DELETE, DIVERSION"
  "submissionTimestamp": "2026-10-15T08:30:00Z",
  
  "manifest": {
    "cargoControlNumber": "1234567890ABCD",
    "scacCode": "ABCD",
    "portOfArrival": "3004",
    "estimatedArrivalDate": "2026-10-18",
    "isBonded": true,
    
    "shipper": {
      "name": "GLOBAL EXPORTS INC",
      "address": "123 TRADE WAY, CHICAGO, IL 60601"
    },
    
    "consignee": {
      "name": "US IMPORTS LLC",
      "address": "999 RECEIVE BLVD, DETROIT, MI 48201"
    },
    
    "equipmentContext": [
      {
        "equipmentInitial": "TTGX",
        "equipmentNumber": 987654,
        "equipmentType": "RR", "// Rail Car"
        "sealNumbers": ["SEAL001", "SEAL002"],
        "isIdler": false
      }
    ],
    
    "commodityList": [
      {
        "description": "ELECTRONIC COMPONENTS",
        "weight": 15000.50,
        "weightUnit": "KG",
        "quantity": 300,
        "quantityUnit": "PCS",
        "valueUSD": 750000.00
      }
    ]
  }
}
← Return to Dashboard